Skip to main content


class %CSP.UI.Portal.Dialog.SQLStatementDetails extends %CSP.UI.Portal.Dialog.WizardTemplate

This class is used internally by InterSystems IRIS. You should not make direct use of it within your applications. There is no guarantee made about either the behavior or future operation of this class.

SQL Statement Details view and freeze plan for Management Portal

Property Inventory

Method Inventory


parameter APPLICATION = %CSP.UI.Portal.Application;
Class name of application this page belongs to.
parameter APPLYBUTTON = 1;
If true, then this dialog displays an Apply button.
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.Dialog.SQLStatementDetails.zen;
Inherited description: This parameter is used to make sure that if multiple CSP applications are mapped to the same namespace that the CSP engine can correctly identify which class corresponds with which URL. If 'LockCSPName' is true (the default, defined in the CSP application) then you can only access this page if the url exactly matches this 'CSPURL'. You can set this parameter to "" if you wish to disable this check for this class. This check is applied for all CSP urls (cls/csp/zen).
If this page was compiled from a .csp file, then this parameter is automatically set to contain the url of this file used for compilation.
parameter PAGENAME = SQLStatementDetails;
Displayed name of this page.
parameter RESOURCE = %Development;
Security requirement


property NAMESPACE as %ZEN.Datatype.string (ZENURL = "NAMESPACE");
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property OpenInTab as %ZEN.Datatype.string (ZENURL = "OpenInTab");
Property methods: OpenInTabDisplayToLogical(), OpenInTabGet(), OpenInTabIsValid(), OpenInTabLogicalToDisplay(), OpenInTabLogicalToOdbc(), OpenInTabNormalize(), OpenInTabSet()
property PlanState as %ZEN.Datatype.integer;
Property methods: PlanStateDisplayToLogical(), PlanStateGet(), PlanStateIsValid(), PlanStateLogicalToDisplay(), PlanStateLogicalToOdbc(), PlanStateNormalize(), PlanStateSet()
property SCHEMA as %ZEN.Datatype.string (ZENURL = "SCHEMA");
Schema name, may or may not be available.
Property methods: SCHEMADisplayToLogical(), SCHEMAGet(), SCHEMAIsValid(), SCHEMALogicalToDisplay(), SCHEMALogicalToOdbc(), SCHEMANormalize(), SCHEMASet()
property STMTHASH as %ZEN.Datatype.string (ZENURL = "STMTHASH");
Property methods: STMTHASHDisplayToLogical(), STMTHASHGet(), STMTHASHIsValid(), STMTHASHLogicalToDisplay(), STMTHASHLogicalToOdbc(), STMTHASHNormalize(), STMTHASHSet()
property ViewStatsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.Portal.SQL.QButtons.RuntimeStats.zen",,1) ];
Property methods: ViewStatsPageDisplayToLogical(), ViewStatsPageGet(), ViewStatsPageIsValid(), ViewStatsPageLogicalToDisplay(), ViewStatsPageLogicalToOdbc(), ViewStatsPageNormalize(), ViewStatsPageSet()
property colCompile as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Compile Routine") ];
Store translated targetCol linkCaption for
Property methods: colCompileDisplayToLogical(), colCompileGet(), colCompileIsValid(), colCompileLogicalToDisplay(), colCompileLogicalToOdbc(), colCompileNormalize(), colCompileSet()
property expTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to expand or collapse this group") ];
Property methods: expTitleDisplayToLogical(), expTitleGet(), expTitleIsValid(), expTitleLogicalToDisplay(), expTitleLogicalToOdbc(), expTitleNormalize(), expTitleSet()
property hashError as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: hashErrorDisplayToLogical(), hashErrorGet(), hashErrorIsValid(), hashErrorLogicalToDisplay(), hashErrorLogicalToOdbc(), hashErrorLogicalToXSD(), hashErrorNormalize(), hashErrorSet(), hashErrorXSDToLogical()
property lblNo as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("No") ];
Property methods: lblNoDisplayToLogical(), lblNoGet(), lblNoIsValid(), lblNoLogicalToDisplay(), lblNoLogicalToOdbc(), lblNoNormalize(), lblNoSet()
property lblYes as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Yes") ];
Property methods: lblYesDisplayToLogical(), lblYesGet(), lblYesIsValid(), lblYesLogicalToDisplay(), lblYesLogicalToOdbc(), lblYesNormalize(), lblYesSet()


method %OnAfterCreatePage() as %Status
This callback is called after the server-side page object and all of its children are created.
Subclasses can override this to add, remove, or modify items within the page object model, or to provide values for controls.
method %OnGetSubtitle() as %String
Get the (localized) subtitle string for the dialog. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the dialog. This should be implemented in a subclass.
method ClearPlanError() as %Status [ ZenMethod ]
method ClearSQLStatistics() as %String [ ZenMethod ]
method CompileClassSetClassname(classname As %String) as %String [ ZenMethod ]
method CompileRoutineSetRoutineName(rtnname As %String) as %String [ ZenMethod ]
classmethod DrawShowPlan(pShowCompare) as %Status
When the current plan is frozen, then we show un-frozen plan on the side for easy comparison
method FreezePlan() as %String [ ZenMethod ]
classmethod GetDisplayAverageCount(averagecount)
This will return the exact same AverageCount as from StatementIndexAll fo %SQL.Manager.Catalog
method RecheckFrozenPlan(hash) as %Status [ ZenMethod ]
This method forces a recheck of frozen plan
method RefreshStatementMetadata() as %Status [ ZenMethod ]
classmethod SaveExpando(pExpandoList) as %Status [ ZenMethod ]
method UnFreezePlan() as %String [ ZenMethod ]
clientmethod checkButtonStatus() [ Language = javascript ]
clientmethod doCheckFrozen() [ Language = javascript ]
This client event is fired when the Check Frozen button is clicked (this button is deprecated)
clientmethod doClearPlanError() [ Language = javascript ]
This client event is fired when the ClearPlanError button is clicked
clientmethod doClearStatistics() [ Language = javascript ]
clientmethod doCompileClass(classname, namespace) [ Language = javascript ]
clientmethod doCompileRoutine(rtnname, namespace) [ Language = javascript ]
clientmethod doExport() [ Language = javascript ]
clientmethod doFreezePlan() [ Language = javascript ]
clientmethod doQueryTest() [ Language = javascript ]
Goto the Test Query tab and put the statement text in
clientmethod doRefreshPage() [ Language = javascript ]
This client event is fired when the Refresh button is clicked
clientmethod doRefreshTable(tablename) [ Language = javascript ]
clientmethod doUnFreezePlan() [ Language = javascript ]
clientmethod onPopupAction(popupName, action, value) [ Language = javascript ]
This client event is fired when the a popup page launched from this page fires an action. action - StatementRefresh is for when returning from compiling a routine or class.
clientmethod ondialogCancel() [ Language = javascript ]
Inherited description: This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.
clientmethod onloadHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is loaded.
clientmethod saveExpState() [ Language = javascript ]
clientmethod showCompare(reload) [ Language = javascript ]
clientmethod updateParentTable() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab