This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

%DeepSee.Report.UI.QueryBasedDSS

class %DeepSee.Report.UI.QueryBasedDSS extends %DeepSee.UI.standardPage

DeepSee Report DSS Generation From Class Queries.

Property Inventory

Method Inventory

Parameters

parameter AUTONS = 0;
Do NOT auto-switch namespace to whatever is passed in work in the user's current space.
parameter DOMAIN = %DeepSee;
Inherited description: Set this to the correct domain.
parameter FAVORITEICON = portal/deepsee.ico;
DeepSee favorite icon.
parameter JSINCLUDES = zenCSLM.js,zenESVG.js;
Inherited description: Comma-separated list of additional JS include files for the page.
parameter PAGENAME = DeepSee Visual Reporting DSS Query-Based Generator;
Displayed name of this page.
parameter USERPACKAGES = %DeepSee.Report.UI;
Inherited description: Comma-separated list of User class packages whose HTML class and style definitions are in pre-generated include files.

Properties

property dataSource as %ZEN.Datatype.string;
Data source. This is a copy of the value in the report model.
Property methods: dataSourceDisplayToLogical(), dataSourceGet(), dataSourceIsValid(), dataSourceLogicalToDisplay(), dataSourceLogicalToOdbc(), dataSourceNormalize(), dataSourceSet()
property defaultRptName as %ZEN.Datatype.string [ InitialExpression = "UnnamedQDSS" ];
The placeholder name given to reports that have yet to be saved to disk
Property methods: defaultRptNameDisplayToLogical(), defaultRptNameGet(), defaultRptNameIsValid(), defaultRptNameLogicalToDisplay(), defaultRptNameLogicalToOdbc(), defaultRptNameNormalize(), defaultRptNameSet()
property nameSpace as %ZEN.Datatype.string (ZENURL = "NAMESPACE");
Name of the currently active default namespace
Property methods: nameSpaceDisplayToLogical(), nameSpaceGet(), nameSpaceIsValid(), nameSpaceLogicalToDisplay(), nameSpaceLogicalToOdbc(), nameSpaceNormalize(), nameSpaceSet()
property reportName as %ZEN.Datatype.string (ZENURL = "CLS");
Name of Report being viewed.
Property methods: reportNameDisplayToLogical(), reportNameGet(), reportNameIsValid(), reportNameLogicalToDisplay(), reportNameLogicalToOdbc(), reportNameNormalize(), reportNameSet()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetProductName() as %String
Get the product name for the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method GetClassProperties(className As %String) as %ZEN.Datatype.string [ ZenMethod ]
Return a JSON string representing an array of the class properties that have ZENURL parameters set for them
classmethod GetXDataTextSection(xdataID As %String) as %String [ ZenMethod ]
method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status
Get information to display in the ribbon bar.
classmethod QueryProcInfo(schema As %String, proc As %String) as %ZEN.Datatype.string [ ZenMethod ]
Return the essential details about an SQL stored procedure as a JSON string
classmethod QueryViewInfo(schema As %String, view As %String) as %ZEN.Datatype.string [ ZenMethod ]
Return the essential details about an SQL view as a JSON string
classmethod SimplifyDataType(formalType As %String) as %String
clientmethod adjustSizes(dnr) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod changeDataSource() [ Language = javascript ]
Launch the data source dialog.
clientmethod convertGrouperToSorter(objSrc) [ Language = javascript ]
clientmethod convertQPARMStoParamModel() [ Language = javascript ]
clientmethod convertSorterToGrouper(objSrc) [ Language = javascript ]
classmethod doit()
clientmethod drawProjectionHeader(title) [ Language = javascript ]
Draw the header for the data projection panel
clientmethod drawSourceHeader(title, msgChange, hlpChange) [ Language = javascript ]
Draw the header for the data source panel
clientmethod exportModelToItemEditor() [ Language = javascript ]
clientmethod generateFieldControlPanelSrc(fld) [ Language = javascript ]
clientmethod generateGroupControlPanelSrc(fld) [ Language = javascript ]
clientmethod generateReportDefinition(qObj) [ Language = javascript ]
clientmethod getDataItemsWidget() [ Language = javascript ]
clientmethod getDataSourceWidget() [ Language = javascript ]
clientmethod getModelServer() [ Language = javascript ]
clientmethod getReportPropertiesWidget() [ Language = javascript ]
clientmethod isNumeric(s) [ Language = javascript ]
Given a column type definition return a flag if the associated data is eligible for numeric agregation
clientmethod logout() [ Language = javascript ]
End the current session.
clientmethod newDSS() [ Language = javascript ]
Invoke dialog to create a new report.
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod onloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod onunloadHandler() [ Language = javascript ]
Check if user really wants to exit if they have not saved changes
clientmethod openDSS() [ Language = javascript ]
Invoke dialog to open a report.
clientmethod orderAscending(idx) [ Language = javascript ]
clientmethod orderDescending(idx) [ Language = javascript ]
clientmethod querySortingControl(ctrlIdx) [ Language = javascript ]
clientmethod reallySaveDSS() [ Language = javascript ]
clientmethod resetDSS() [ Language = javascript ]
reset the active editors
clientmethod saveAsDSS() [ Language = javascript ]
Rename this report and save it to disk.
clientmethod saveDSS() [ Language = javascript ]
Save the report.
clientmethod setDataSource(qObj) [ Language = javascript ]
Set the dataSource for the report.
clientmethod setRDefDefaults(qObj) [ Language = javascript ]
clientmethod setRibbonTitle(str) [ Language = javascript ]
Set the title block section of the ribbon to the given text
clientmethod setViewModeHandler(mode As %Library.String, oldmode As %Library.String) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
clientmethod updateAggregates(fNum, aggName, ctrl) [ Language = javascript ]
clientmethod updateFieldControls() [ Language = javascript ]
clientmethod updateGroupControlPanel() [ Language = javascript ]
Update the presentation state of the group control panel to reflect the current settings of the underlying model
clientmethod updateGroupings(ctrlIdx, trigger) [ Language = javascript ]
Update the underlying model to reflect the curent state of the group and sort controls
clientmethod updateModelFromItemEditor() [ Language = javascript ]
clientmethod updatePropertiesGroup() [ Language = javascript ]
clientmethod updateQPARMSFromEditor() [ Language = javascript ]
clientmethod updateReportProjection() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

Feedback