This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > %SYS namespace > %DeepSee.Report.UI.CreateDCR


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

DeepSee Report DCR Builder page.

Property Inventory (Including Private)

Method Inventory (Including Private)


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 Data Collector Builder;
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 (Including Private)

property dataSelect as %ZEN.Datatype.string [ InitialExpression = "ByField" ];
Data selection type. This sets the editor's mode of operation To either select individual data fields (ByField) and create an SQL statement, or to use a predefined class query and skip a lot of low level stuff in favor of some quick defaults (ByQuery).
Property methods: dataSelectDisplayToLogical(), dataSelectGet(), dataSelectIsValid(), dataSelectLogicalToDisplay(), dataSelectLogicalToOdbc(), dataSelectNormalize(), dataSelectSet()
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 = "UnnamedDCR" ];
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()
property selectedDataField as %ZEN.Datatype.integer;
Local copy of report model object. Index (0-based) of selected data field (if any).
Property methods: selectedDataFieldDisplayToLogical(), selectedDataFieldGet(), selectedDataFieldIsValid(), selectedDataFieldLogicalToDisplay(), selectedDataFieldLogicalToOdbc(), selectedDataFieldNormalize(), selectedDataFieldSet()

Methods (Including Private)

Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
This class method callback is called just before the server-side page object is created.
private method %OnGetJSResources(ByRef pResources As %String) as %Status
Inherited description: Pages can implement this callback method in order to define a set of client-side resources: javascript strings that have been localized.
This method should fill in the array pResources with a set of localized strings, indexed by resource id:
   Set pResources("MyId") = $$$Text("Some string")
Javascript methods can refer to these resources using the helper function zenGetResource:
Zen defines a set of built-in resource strings using this mechanism. These have a "zen" prefix to keep them seperate from user ids.
You can also override the same callback method within your %ZEN.application class if you wish to share resources across an application. In this case, the application-wide callback is invoked first.
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 GetClassQueries(className As %String) as %ZEN.Datatype.string [ ZenMethod ]
Return a JSON string in the form of an array of function names where the named functions are all queries associated with the given class If the class cannot be openned the string ERROR will be returned. If the class has no defined queries the string "[]" will be returned.
method GetQueryInfo(queryClass As %String, queryName As %String) as %ZEN.Datatype.string [ ZenMethod ]
Given a class and query method name, return a JSON string for an object with two fields. "data" is an array of objects where each object has a name, type and caption field and represents a returned column from the query. "arg" is an array of objects where each object has a name and type and represents a parameter of the query function (in order of passing). If the class cannot be read, the query returns the string "$$$NoJoy"
method GetSQLTableName(classname As %ZEN.Datatype.string) as %ZEN.Datatype.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.
clientmethod adjustSizes(dnr) [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod backupCurrentModel() [ Language = javascript ]
Create a temporary backup of the active client-side model for 'undo' purposes
clientmethod changeDataSource() [ Language = javascript ]
Launch the data source dialog.
clientmethod getDataPropertiesWidget() [ Language = javascript ]
clientmethod getDataSourceWidget() [ Language = javascript ]
clientmethod getMethodEditorWidget() [ Language = javascript ]
clientmethod getModelServer() [ Language = javascript ]
clientmethod getReportPropertiesWidget() [ Language = javascript ]
clientmethod getSchemaTableWidget() [ Language = javascript ]
clientmethod getWhereClauseWidget() [ Language = javascript ]
clientmethod logout() [ Language = javascript ]
End the current session.
clientmethod newDCR() [ 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 openDCR() [ Language = javascript ]
Invoke dialog to open a report.
clientmethod reallySaveDCR() [ Language = javascript ]
Save the report.
clientmethod resetDCR() [ Language = javascript ]
reset the active editors
clientmethod restoreCurrentBackup() [ Language = javascript ]
Reset the model to a previous locally-stored state
clientmethod restoreDCR(m) [ Language = javascript ]
Restore UI settings based on a freshly loaded model
clientmethod saveAsDCR() [ Language = javascript ]
Rename this report and save it to disk.
clientmethod saveDCR() [ Language = javascript ]
Save the report.
clientmethod scanForFieldNames(node, a) [ Language = javascript ]
clientmethod scanForSorters(n, l) [ Language = javascript ]
clientmethod schemaTableDropHandler(dragData) [ Language = javascript ]
Data drop on data property table.
clientmethod setDataSource(cls) [ Language = javascript ]
Set the dataSource for the report.
clientmethod setRibbonTitle(str) [ Language = javascript ]
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 updateBaseSQL() [ Language = javascript ]
clientmethod updateModelFromEditors() [ Language = javascript ]
clientmethod updateOrderByClause() [ Language = javascript ]

Inherited Members

Inherited Properties (Including Private)

Inherited Methods (Including Private)