Skip to main content


class %CSP.UI.Portal.SQL.QButtons.RuntimeStats extends %CSP.UI.Template.Property, %CSP.UI.Portal.UtilsNav

System Management Portal - SQL Performance Tool

Property Inventory

Method Inventory


parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.RuntimeStats.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 HELPADDRESS = Home,SQL Runtime Statistics;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = SQL.QButtons.RuntimeStats;
Displayed name of this page.
parameter RESOURCE = %Development:USE;
Inherited description: This is a comma-delimited list of system Resources and associated permissions. A user must hold the specified permissions on at least one of the specified resources in order to view this page or invoke any of its server-side methods from the client.
The format of each item in the list should be as follows:
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.


property PlanPage as %String;
Property methods: PlanPageDisplayToLogical(), PlanPageGet(), PlanPageIsValid(), PlanPageLogicalToDisplay(), PlanPageLogicalToOdbc(), PlanPageNormalize(), PlanPageSet()
property TurnOnStats as %Integer;
Property methods: TurnOnStatsDisplayToLogical(), TurnOnStatsGet(), TurnOnStatsIsValid(), TurnOnStatsLogicalToDisplay(), TurnOnStatsNormalize(), TurnOnStatsSet(), TurnOnStatsXSDToLogical()
property colDetails as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Details") ];
Store translated targetCol linkCaption for
Property methods: colDetailsDisplayToLogical(), colDetailsGet(), colDetailsIsValid(), colDetailsLogicalToDisplay(), colDetailsLogicalToOdbc(), colDetailsNormalize(), colDetailsSet()
property msgPurgeQuery as %ZEN.Datatype.string [ InitialExpression = $$$TextJS("Purge all cached queries failed.") ];
Property methods: msgPurgeQueryDisplayToLogical(), msgPurgeQueryGet(), msgPurgeQueryIsValid(), msgPurgeQueryLogicalToDisplay(), msgPurgeQueryLogicalToOdbc(), msgPurgeQueryNormalize(), msgPurgeQuerySet()
property msgPurgeQueryDone as %ZEN.Datatype.string [ InitialExpression = $$$TextJS("Purge all cached queries done.") ];
Property methods: msgPurgeQueryDoneDisplayToLogical(), msgPurgeQueryDoneGet(), msgPurgeQueryDoneIsValid(), msgPurgeQueryDoneLogicalToDisplay(), msgPurgeQueryDoneLogicalToOdbc(), msgPurgeQueryDoneNormalize(), msgPurgeQueryDoneSet()
property msgStatsChange as %ZEN.Datatype.string [ InitialExpression = $$$TextJS("Show Plan stats flag changed.") ];
Property methods: msgStatsChangeDisplayToLogical(), msgStatsChangeGet(), msgStatsChangeIsValid(), msgStatsChangeLogicalToDisplay(), msgStatsChangeLogicalToOdbc(), msgStatsChangeNormalize(), msgStatsChangeSet()


method %OnAfterCreatePage() as %Status
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
method DrawDetailsTitle(pData) as %Status
Draw html for details title: Routine name and Query text
method DrawPurgeQuery(pSeed) as %Status
classmethod GetImportSchema(pCursor, pRoutine, pInternal=0) as %String [ ZenMethod ]
classmethod GetQueryText(pCursor, pRoutine, pInternal=0) 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 PrepareShowPlan(query, schema="", id="") [ ZenMethod ]
classmethod PurgeQuery(pNamespace) as %String [ ZenMethod ]
This method returns 1 (success) or 0.
classmethod SaveSQLStats(newOption) as %Integer [ ZenMethod ]
clientmethod adjustSizes() [ Language = javascript ]
clientmethod changeOption(newOption) [ Language = javascript ]
clientmethod doDetails(cursorName, routineName) [ Language = javascript ]
clientmethod doPurgeQuery() [ Language = javascript ]
clientmethod doSelectRow(cursorName, routineName) [ Language = javascript ]
clientmethod doShowPlan() [ Language = javascript ]
clientmethod doView() [ 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.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is first loaded or whenever it is resized.
If this is called at load time, then load will be true.
clientmethod onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded. Enable the first tab and disable the rest.
clientmethod tabChanged(index) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab