Home > Class Reference > ENSLIB namespace > %CSP.UI.Portal.Dialog.SQLStatementDetails
Private  Storage   


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


Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 11 32


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

%condition %import %includeFiles %page
%resource FirstFailed InvalidParam IsEMSReadOnly
STMTHASH ValidationErrorMsg ViewStatsPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children colCompile
composite containerStyle cssLevel dialogTitle
disabled disabledStyle dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
expTitle groupClass groupStyle hashError
height helpId hidden hideApplyButton
hideCancelButton hint hintClass hintStyle
id index label labelClass
labelDisabledClass labelPosition labelStyle layout
lblNo lblYes name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
parent showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

%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 %DrawTitle %EnclosingDivId
%EndBackgroundMethod %EndScript %Eval %EvalC
%Extends %ForceClientRender %GetChildIndex %GetComponent
%GetComponentById %GetComponentByName %GetEventHandlers %GetLinks
%GetPageName %GetParameter %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 %OnGetSubtitle
%OnGetTitle %OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch
%OnPreHTTP %OnSubmit %OnUseSoftModals %OnZENDeserialize
%OriginalNamespace %PackageName %QuoteValue %QuoteValueL10N
%RemoveChild %RemoveChildren %RemoveComponent %RemoveFromSaveSet
%RunBackgroundMethod %Self %SerializeObject %SetBackgroundMethodStatus
%SetErrorById %SetErrorByName %SetModified %SetValueById
%SetValueByName %SetValuesByName %StartScript %ValidateObject
%ZENVersion ClearPlanError ClearSQLStatistics CompileClassSetClassname
CompileRoutineSetRoutineName ConvertParameter Decrypt DrawShowPlan
Encrypt EscapeHTML EscapeURL EvalResult
FreezePlan GetDisplayAverageCount HyperEventCall HyperEventHead
Include InsertHiddenField InsertHiddenFields IsEnabled
IsPrivate Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RecheckFrozenPlan
RefreshStatementMetadata RewriteURL SaveExpando ShowError
StartTimer StopTimer ThrowError UnFreezePlan
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore adjustSize btnApply btnOK
canFinish canGoBack canGoNext cancelPopup
checkButtonStatus childrenMutated correctIELayering createComponent
createComponentNS ctrlKeyDown deleteComponent dialogApply
dialogCancel dialogFinish dialogTitleGet disableButtons
doCheckFrozen doClearPlanError doClearStatistics doCompileClass
doCompileRoutine doExport doFreezePlan doQueryTest
doRefreshPage doRefreshTable doUnFreezePlan dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler dropHandler
dropStartHandler endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
formValidationHandler getChildIndex getComponent getComponentById
getDialogValue getEnclosingDiv getHidden getHintElement
getLabelElement getOpener getProperty getSettings
getType gotoPage hasMultiplePages invokeSuper
isOfType launchPopupWindow makeId nextPage
onCreate onDelete onDisplayHandler onEndModalHandler
onPopupAction onRefreshContents onSerialize onServerMethodCall
onServerMethodError onServerMethodReturn onStartModalHandler ondialogCancel
ondialogFinish ondialogStart ondisabledHandler onfinishHandler
onkeydownHandler onkeyupHandler onlayoutHandler onloadHandler
onlogoutHandler onoverlayHandler onresizeHandler onstartHandler
onunloadHandler onupdateHandler popupActionHandler previousPage
refreshContents removeChild render renderContents
renderSVG resetMsg saveExpState setComponentId
setHidden setOverlayMode setProperty setPropertyAll
setTraceOption showCompare showDocumentation showHelp
showMsg startModal startProgressBar stopProgressBar
updateParentTable updateState validateRequired


• 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";
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 OpenInTab as %ZEN.Datatype.string(ZENURL="OpenInTab");
• property PlanState as %ZEN.Datatype.integer;
• property SCHEMA as %ZEN.Datatype.string(ZENURL="SCHEMA");
Schema name, may or may not be available.
• property STMTHASH as %ZEN.Datatype.string(ZENURL="STMTHASH");
• property ViewStatsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.Portal.SQL.QButtons.RuntimeStats.zen",,1) ];
• property colCompile as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Compile Routine") ];
Store translated targetCol linkCaption for
• property expTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to expand or collapse this group") ];
• property hashError as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
• property lblNo as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("No") ];
• property lblYes as %ZEN.Datatype.caption [ InitialExpression = $$$TextHTML("Yes") ];


• 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 ]
• method checkButtonStatus() [ Language = javascript ]
• method doCheckFrozen() [ Language = javascript ]
This client event is fired when the Check Frozen button is clicked (this button is deprecated)
• method doClearPlanError() [ Language = javascript ]
This client event is fired when the ClearPlanError button is clicked
• method doClearStatistics() [ Language = javascript ]
• method doCompileClass(classname, namespace) [ Language = javascript ]
• method doCompileRoutine(rtnname, namespace) [ Language = javascript ]
• method doExport() [ Language = javascript ]
• method doFreezePlan() [ Language = javascript ]
• method doQueryTest() [ Language = javascript ]
Goto the Test Query tab and put the statement text in
• method doRefreshPage() [ Language = javascript ]
This client event is fired when the Refresh button is clicked
• method doRefreshTable(tablename) [ Language = javascript ]
• method doUnFreezePlan() [ Language = javascript ]
• method 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.
• method ondialogCancel() [ Language = javascript ]
This callback, if defined, is called when the user presses the Cancel button. If this returns false, then the dialog is not cancelled.
• method onloadHandler(load) [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method saveExpState() [ Language = javascript ]
• method showCompare(reload) [ Language = javascript ]
• method updateParentTable() [ Language = javascript ]