%CSP.UI.Portal.SQL.QButtons.RuntimeStats

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

System Management Portal - SQL Performance Tool

Property Inventory

Method Inventory

Parameters

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:
Resource[:Permission]
Permission is optional, and defaults to USE if not supplied. If it is supplied, it should be one of USE, READ or WRITE.

Properties

property IndexAnalyzerPage as %ZEN.Datatype.string [ InitialExpression = ..Link("%25CSP.UI.Portal.SQL.QButtons.IndexAnalyzer.zen") ];
Property methods: IndexAnalyzerPageDisplayToLogical(), IndexAnalyzerPageGet(), IndexAnalyzerPageIsValid(), IndexAnalyzerPageLogicalToDisplay(), IndexAnalyzerPageLogicalToOdbc(), IndexAnalyzerPageNormalize(), IndexAnalyzerPageSet()
property OpenDetailsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.Portal.SQL.QButtons.RuntimeStatsDetails.cls",,1) ];
Property methods: OpenDetailsPageDisplayToLogical(), OpenDetailsPageGet(), OpenDetailsPageIsValid(), OpenDetailsPageLogicalToDisplay(), OpenDetailsPageLogicalToOdbc(), OpenDetailsPageNormalize(), OpenDetailsPageSet()
property PlanPage as %String;
Property methods: PlanPageDisplayToLogical(), PlanPageGet(), PlanPageIsValid(), PlanPageLogicalToDisplay(), PlanPageLogicalToOdbc(), PlanPageNormalize(), PlanPageSet()
property ShowPlanOutput as %String;
Property methods: ShowPlanOutputDisplayToLogical(), ShowPlanOutputGet(), ShowPlanOutputIsValid(), ShowPlanOutputLogicalToDisplay(), ShowPlanOutputLogicalToOdbc(), ShowPlanOutputNormalize(), ShowPlanOutputSet()
property ViewProcessPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/op/%25CSP.UI.Portal.ProcessDetails.zen",,1) ];
Property methods: ViewProcessPageDisplayToLogical(), ViewProcessPageGet(), ViewProcessPageIsValid(), ViewProcessPageLogicalToDisplay(), ViewProcessPageLogicalToOdbc(), ViewProcessPageNormalize(), ViewProcessPageSet()
property colDetails as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Details") ];
Store translated targetCol linkCaption for
Property methods: colDetailsDisplayToLogical(), colDetailsGet(), colDetailsIsValid(), colDetailsLogicalToDisplay(), colDetailsLogicalToOdbc(), colDetailsNormalize(), colDetailsSet()
property openTab as %ZEN.Datatype.string (ZENURL = "openTab");
Property methods: openTabDisplayToLogical(), openTabGet(), openTabIsValid(), openTabLogicalToDisplay(), openTabLogicalToOdbc(), openTabNormalize(), openTabSet()

Methods

Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Inherited description: Be sure to do ##super() when overriding.
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page. This should be implemented in a subclass.
method DrawDetailsTitle(pData) as %Status [ Language = objectscript ]
Draw html for details title: Routine name and Query text
method DrawQueryText(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status [ Language = objectscript ]
Write upto 80 characters of query statement in tablePane
method GetSettingsInfo(ByRef pParms, Output pObject As %RegisteredObject) as %Status [ Language = objectscript ]
Return server info per View Stats.
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 [ Language = objectscript ]
Get information to display in the ribbon bar.
classmethod PurgeStats(pNamespace) as %ZEN.proxyObject [ Language = objectscript, ZenMethod ]
This method clears Stats in the current namespace. Returns the number of Stats deleted from the '%SYS.PTools.Stats' class; Otherwise, returns an error message if an error occurred.
clientmethod adjustSizes() [ Language = javascript ]
clientmethod doClearQueryText() [ Language = javascript ]
clientmethod doHistory() [ Language = javascript ]
clientmethod doPurgeQuery() [ Language = javascript ]
clientmethod doPurgeStats() [ Language = javascript ]
clientmethod doSelectRow(cursorName, routineName) [ Language = javascript ]
clientmethod doSettings() [ Language = javascript ]
clientmethod doShowPlan() [ Language = javascript ]
clientmethod doView() [ Language = javascript ]
clientmethod doViewProcess() [ Language = javascript ]
View details of a background process for Show Plan
clientmethod historyFilterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
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 onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
clientmethod openDetails(cursorName, routineName) [ Language = javascript ]
clientmethod selectHistory(tID) [ Language = javascript ]
This method processes actions for a query history item.
clientmethod tabChanged(index) [ Language = javascript ]
clientmethod timeout() [ Language = javascript ]
clientmethod toggleFields(hideflag) [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

Feedback