Class Reference
IRIS for UNIX 2024.1.2
InterSystems: The power behind what matters   
Documentation  Search
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [SQL] >  [QButtons] >  [RuntimeStats]
Private  Storage   

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 7 30


Summary

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

Properties
%condition %import %includeFiles %page
%resource Filter FirstFailed HelpAddress
ISREADONLY IndexAnalyzerPage InvalidParam IsEMSReadOnly
IsEditForm LocatorHeader NAMESPACE OnclickArray
OpenDetailsPage PID ParentURL PlanPage
SQLHomePage ShowPlanOutput StdTitle TableMaxRows
TablePageSize ValidationErrorMsg ViewProcessPage aboutPage
align aux backgroundTimerInterval cellAlign
cellSize cellStyle cellVAlign children
colDetails composite contactPage containerStyle
cssLevel currSortMode currStep currViewMode
disabled dragAndDrop dragEnabled dropEnabled
enableAutoRefresh enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index label
labelClass labelDisabledClass labelPosition labelStyle
layout lblTitle limitPopups name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate openTab pageModified parent
searchKey showLabel slice title
tuple useSVG useSoftModals valign
visible width window zenPersistentPopup

Methods
%AddChild %AddChildAfter %AddChildBefore %AddComponent
%AddImportedComponents %AddLocatorLinks %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 %GetHomePage
%GetHomeParam %GetLinks %GetLocatorLinks %GetNavTableState
%GetPageName %GetParameter %GetProductName %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 CheckAllBlanks CheckContextLinks
CheckEnterpriseManager CheckJobStatus ConvertParameter Decrypt
DoLogout DrawDetailsTitle DrawLocator DrawQueryText
DrawRibbon DrawTitle DrawUpto40Text Encrypt
EscapeHTML EscapeURL EvalResult GetCSPURL
GetContextLinks GetDocURL GetHomePage GetImportSchema
GetIndexAnalyzerProperties GetNewURL GetQueryData GetQueryHistoryText
GetQueryText GetQuickLinks GetSQLPageData GetSettingsData
GetSettingsInfo HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate JavaInstalled
JobShowPlan Link OnDrawRibbon OnGetRibbonInfo
OnHTTPHeader OnPage OnPageError OnPostHTTP
OnPostHyperEvent OnPreHTTP OnPreHyperEvent Page
PrepareShowPlan PurgeQuery PurgeStats QuoteJS
RegisterRecent RewriteURL ShowError StartTimer
StopTimer ThrowError UnescapeHTML UnescapeURL
UpdateTableNavState XMLDTD XMLExport XMLExportToStream
XMLExportToString XMLNew XMLSchema XMLSchemaNamespace
XMLSchemaType addChild addChildAfter addChildBefore
adjustSizes afterSave afterValidate cancelPopup
changePassword childrenMutated correctIELayering createComponent
createComponentNS deleteComponent disableCommandButton doCancel
doClearQueryText doHistory doModified doPurgeQuery
doPurgeStats doSelectRow doSettings doShowPlan
doView doViewProcess dragFinishHandler dragHandler
dragNotifyHandler dragStartHandler dropHandler dropStartHandler
enableCommandButton endModal exposeComponent findElement
fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent firePopupAction
getChildIndex getComponent getComponentById getEnclosingDiv
getHidden getHintElement getLabelElement getOpener
getPageTitle getProperty getSettingMessages getSettings
getTitleAreaHeight getType goHome goMenu
gotoNamespace gotoPToolsPage gotoPage hideCommandButton
historyFilterChanged invokeSuper isButtonDisabled isOfType
launchPopupWindow logout makeId navMaxRowsChanged
navPageSizeChanged navigate onCreate onDelete
onDisplayHandler onEndModalHandler onPopupAction onRefreshContents
onSerialize onServerMethodCall onServerMethodError onServerMethodReturn
onStartModalHandler ondisabledHandler onhandleAutoLogoutWarn onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
openDetails popupActionHandler refreshContents removeChild
render renderContents renderSVG resetMsg
searchBlur searchBoxHandler searchFocus searchKeyDown
searchKeyPress selectHistory setComponentId setConnectivityStatusMsg
setHidden setModified setOverlayMode setPageTitle
setProperty setPropertyAll setSortMode setSortModeHandler
setTraceOption setViewMode setViewModeHandler showAbout
showCommandButton showContact showDocumentation showExpand
showHelp showMsg startModal startProgressBar
stopProgressBar switchNamespace tabChanged timeout
toggleClearText toggleFields toggleSettings trimSpace
validateRequired


Parameters

• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.RuntimeStats.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 HELPADDRESS = "Home,SQL Runtime Statistics";
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";
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 OpenDetailsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.Portal.SQL.QButtons.RuntimeStatsDetails.cls",,1) ];
• property PlanPage as %String;
• property ShowPlanOutput as %String;
• property ViewProcessPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/op/%25CSP.UI.Portal.ProcessDetails.zen",,1) ];
• property colDetails as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Details") ];
Store translated targetCol linkCaption for
• property openTab as %ZEN.Datatype.string(ZENURL="openTab");

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
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 DrawQueryText(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Write upto 80 characters of query statement in tablePane
• method GetSettingsInfo(ByRef pParms, Output pObject As %RegisteredObject) as %Status
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
Get information to display in the ribbon bar.
• classmethod PurgeStats(pNamespace) as %ZEN.proxyObject [ 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.
• method adjustSizes() [ Language = javascript ]
• method doClearQueryText() [ Language = javascript ]
• method doHistory() [ Language = javascript ]
• method doPurgeQuery() [ Language = javascript ]
• method doPurgeStats() [ Language = javascript ]
• method doSelectRow(cursorName, routineName) [ Language = javascript ]
• method doSettings() [ Language = javascript ]
• method doShowPlan() [ Language = javascript ]
• method doView() [ Language = javascript ]
• method doViewProcess() [ Language = javascript ]
View details of a background process for Show Plan
• method historyFilterChanged(value) [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
• 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 ]
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.
• method onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded. Enable the first tab and disable the rest.
• method onresizeHandler() [ Language = javascript ]
This client event, if present, is fired when the page is resized.
• method onunloadHandler() [ Language = javascript ]
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).
• method openDetails(cursorName, routineName) [ Language = javascript ]
• method selectHistory(tID) [ Language = javascript ]
This method processes actions for a query history item.
• method tabChanged(index) [ Language = javascript ]
• method timeout() [ Language = javascript ]
• method toggleFields(hideflag) [ Language = javascript ]


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