Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%DeepSee] >  [Report] >  [UI] >  [QueryBasedDSS]
Private  Storage   

DeepSee Report DSS Generation From Class Queries.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 4 57


Summary

This is a Zen Page class. It belongs to the application %ZEN.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource StdTitle aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
contactPage containerStyle cssLevel currSortMode
currStep currViewMode dataSource defaultRptName
disabled docbookId dragAndDrop dragEnabled
dropEnabled enableAutoRefresh enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
homePage id index label
labelClass labelDisabledClass labelPosition labelStyle
layout limitPopups metaData name
nameSpace onafterdrag onbeforedrag onclick
ondrag ondrop onhide onrefresh
onshow onupdate pageModified parent
reportName searchKey showLabel slice
title tuple useSVG useSoftModals
valign visible width window
zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddToSaveSet %ApplyURLParms %Attr
%BindExport %ClassIsLatestVersion %ClassName %ConstructClone
%DispatchClassMethod %DispatchGetModified %DispatchGetProperty %DispatchMethod
%DispatchSetModified %DispatchSetMultidimProperty %DispatchSetProperty %DrawAutoLogout
%DrawClassDefinitions %DrawComponentHTML %DrawHTML %DrawHTMLPage
%DrawJSStrings %DrawObjectDefinitions %EnclosingDivId %EndBackgroundMethod
%EndScript %Eval %EvalC %Extends
%ForceClientRender %GetChildIndex %GetComponent %GetComponentById
%GetComponentByName %GetEventHandlers %GetLinks %GetLocatorLinks
%GetPageName %GetParameter %GetRootLink %GetValueById
%GetValueByName %GetXMLName %IsA %IsModified
%Link %LinkCSS %LinkScript %MakeId
%New %NormalizeObject %ObjectModified %OnAddToPageAfter
%OnAddToPageBefore %OnAfterCreatePage %OnBeforeCreatePage %OnCreateApplication
%OnCreatePage %OnDetermineCSSLevel %OnDrawEnclosingDiv %OnDrawHTMLBody
%OnDrawHTMLHead %OnDrawHTMLMeta %OnDrawObjectProperties %OnFinishBackgroundTask
%OnGetPageName %OnGetProductName %OnGetSmallMenu %OnGetTitle
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %Register
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion BuildMenu CheckContextLinks CheckEnterpriseManager
ConvertParameter Decrypt DoLogout DrawLocator
DrawRibbon DrawTitle Encrypt EscapeHTML
EscapeURL GetCSPURL GetClassProperties GetContextLinks
GetDocURL GetNewURL GetQuickLinks GetXDataTextSection
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled Link
OnDrawRibbon OnGetRibbonInfo OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QueryProcInfo QueryViewInfo
QuoteJS RewriteURL ShowError SimplifyDataType
StartTimer StopTimer ThrowError UnescapeHTML
UnescapeURL XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
adjustSizes cancelPopup changeDataSource changePassword
childrenMutated convertGrouperToSorter convertQPARMStoParamModel convertSorterToGrouper
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doit dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler drawProjectionHeader drawSourceHeader
dropHandler dropStartHandler enableCommandButton endModal
exportModelToItemEditor exposeComponent findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction generateFieldControlPanelSrc
generateGroupControlPanelSrc generateReportDefinition getChildIndex getComponent
getComponentById getDataItemsWidget getDataSourceWidget getEnclosingDiv
getHidden getHintElement getLabelElement getModelServer
getOpener getPageMeta getPageTitle getProperty
getReportPropertiesWidget getSettings getTitleAreaHeight getType
goHome goMenu gotoNamespace gotoPage
hideCommandButton invokeSuper isNumeric isOfType
launchPopupWindow logout makeId navigate
newDSS onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler onkeyupHandler
onlayoutHandler onloadHandler onlogoutHandler onoverlayHandler
onresizeHandler onunloadHandler onupdateHandler openDSS
orderAscending orderDescending popupActionHandler querySortingControl
reallySaveDSS refreshContents reloadPage removeChild
render renderContents renderSVG resetDSS
saveAsDSS saveDSS searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress setComponentId
setConnectivityStatusMsg setDataSource setHidden setModified
setOverlayMode setPageTitle setProperty setPropertyAll
setRDefDefaults setRibbonTitle setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showHelp startModal
startProgressBar stopProgressBar switchNamespace updateAggregates
updateFieldControls updateGroupControlPanel updateGroupings updateModelFromItemEditor
updatePropertiesGroup updateQPARMSFromEditor updateReportProjection


Parameters

• parameter AUTONS = 0;
Do NOT auto-switch namespace to whatever is passed in work in the user's current space.
• parameter JSINCLUDES = "zenCSLM.js,zenESVG.js";
Comma-separated list of additional JS include files for the page.
• parameter PAGENAME = "Visual Reporting DSS Query-Based Generator";
Displayed name of this page.
• parameter USERPACKAGES = "%DeepSee.Report.UI";
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 defaultRptName as %ZEN.Datatype.string [ InitialExpression = "UnnamedQDSS" ];
The placeholder name given to reports that have yet to be saved to disk
• property nameSpace as %ZEN.Datatype.string(ZENURL="NAMESPACE");
Name of the currently active default namespace
• property reportName as %ZEN.Datatype.string(ZENURL="CLS");
Name of Report being viewed.

Methods

• method %GetLocatorLinks(Output pLink) as %Status
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
• method adjustSizes(dnr) [ Language = javascript ]
Adjust sizes of components on the page.
• method changeDataSource() [ Language = javascript ]
Launch the data source dialog.
• method convertGrouperToSorter(objSrc) [ Language = javascript ]
• method convertQPARMStoParamModel() [ Language = javascript ]
• method convertSorterToGrouper(objSrc) [ Language = javascript ]
• classmethod doit()
• method drawProjectionHeader(title) [ Language = javascript ]
Draw the header for the data projection panel
• method drawSourceHeader(title, msgChange, hlpChange) [ Language = javascript ]
Draw the header for the data source panel
• method exportModelToItemEditor() [ Language = javascript ]
• method generateFieldControlPanelSrc(fld) [ Language = javascript ]
• method generateGroupControlPanelSrc(fld) [ Language = javascript ]
• method generateReportDefinition(qObj) [ Language = javascript ]
• method getDataItemsWidget() [ Language = javascript ]
• method getDataSourceWidget() [ Language = javascript ]
• method getModelServer() [ Language = javascript ]
• method getReportPropertiesWidget() [ Language = javascript ]
• method isNumeric(s) [ Language = javascript ]
Given a column type definition return a flag if the associated data is eligible for numeric agregation
• method logout() [ Language = javascript ]
End the current session.
• method newDSS() [ Language = javascript ]
Invoke dialog to create a new report.
• method onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action.
• method onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method onlogoutHandler() [ Language = javascript ]
Ensure that auto-logout is not blocked by onunloadHandler checking for unsaved changes
• method onunloadHandler() [ Language = javascript ]
Check if user really wants to exit if they have not saved changes
• method openDSS() [ Language = javascript ]
Invoke dialog to open a report.
• method orderAscending(idx) [ Language = javascript ]
• method orderDescending(idx) [ Language = javascript ]
• method querySortingControl(ctrlIdx) [ Language = javascript ]
• method reallySaveDSS() [ Language = javascript ]
• method resetDSS() [ Language = javascript ]
reset the active editors
• method saveAsDSS() [ Language = javascript ]
Rename this report and save it to disk.
• method saveDSS() [ Language = javascript ]
Save the report.
• method setDataSource(qObj) [ Language = javascript ]
Set the dataSource for the report.
• method setRDefDefaults(qObj) [ Language = javascript ]
• method setRibbonTitle(str) [ Language = javascript ]
Set the title block section of the ribbon to the given text
• method setViewModeHandler(mode) [ Language = javascript ]
Do the actual work of updating the view to match the current view mode.
• method updateAggregates(fNum, aggName, ctrl) [ Language = javascript ]
• method updateFieldControls() [ Language = javascript ]
• method updateGroupControlPanel() [ Language = javascript ]
Update the presentation state of the group control panel to reflect the current settings of the underlying model
• method updateGroupings(ctrlIdx, trigger) [ Language = javascript ]
Update the underlying model to reflect the curent state of the group and sort controls
• method updateModelFromItemEditor() [ Language = javascript ]
• method updatePropertiesGroup() [ Language = javascript ]
• method updateQPARMSFromEditor() [ Language = javascript ]
• method updateReportProjection() [ Language = javascript ]


Copyright (c) 2025 by InterSystems Corporation. Cambridge, Massachusetts, U.S.A. All rights reserved. Confidential property of InterSystems Corporation.