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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
4 8 31 2


Summary

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

Properties
%condition %import %includeFiles %page
%resource COMPAREROWS Filter FirstFailed
HelpAddress ISREADONLY InvalidParam IsCompare
IsEMSReadOnly IsEditForm JOBID LocatorHeader
NAMESPACE OnclickArray PID ParentURL
PlanPage QUERYCLASS QUERYNAME QUERYTEXT
SQLHomePage StdTitle TableMaxRows TablePageSize
ValidationErrorMsg ViewProcessPage aboutPage align
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children 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 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 CreateRS
CreateRSCompare Decrypt DoLogout DrawDetailsTitle
DrawLocator DrawRibbon DrawTitle DrawUpto40Text
Encrypt EscapeHTML EscapeURL EvalResult
ExecuteRS ExecuteRSCompare GetCSPURL GetContextLinks
GetDocURL GetHomePage GetImportSchema GetIndexAnalyzerProperties
GetNewURL GetQueryData GetQueryHistoryText GetQueryText
GetQuickLinks GetSQLPageData GetSettingsData GetSettingsInfo
HyperEventCall HyperEventHead Include InsertHiddenField
InsertHiddenFields IsPrivate JavaInstalled JobComparePlans
JobPossiblePlans JobShowPlan Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PrepareShowPlan PurgeQuery 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 doComparePlans doGetPlans doHistory
doModified doShowPlan 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 popupActionHandler possiblePlansClose possiblePlansExecute
possiblePlansFetch possiblePlansStatsClose possiblePlansStatsExecute possiblePlansStatsFetch
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
timeout toggleClearText toggleFields toggleSettings
trimSpace validateRequired


Parameters

• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.ShowPlanAlt.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 Alternate Show Plans";
Each SMP page should set this link which points to the documentation anchor name.
• parameter PAGENAME = "SQL.QButtons.ShowPlanAlt";
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 COMPAREROWS as %ZEN.Datatype.string;
• property IsCompare as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Whether the current background job is for compare show plan
• property JOBID as %ZEN.Datatype.integer;
• property PlanPage as %String;
• property QUERYCLASS as %ZEN.Datatype.string [ InitialExpression = "%CSP.UI.Portal.SQL.QButtons.ShowPlanAlt" ];
• property QUERYNAME as %ZEN.Datatype.string [ InitialExpression = "possiblePlans" ];
• property QUERYTEXT as %ZEN.Datatype.string;
• property ViewProcessPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/op/%25CSP.UI.Portal.ProcessDetails.zen",,1) ];

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 CreateRS(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
pInfo holds details on how to create the query.
• method CreateRSCompare(Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %ResultSet
pInfo holds details on how to create the query for compare show plans run in the background
• method DrawDetailsTitle(pSeed) as %Status
Draw html for details title: Routine name and Query text
• method ExecuteRS(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for executing the process query.
• method ExecuteRSCompare(pRS As %Library.ResultSet, Output tSC As %Status, pInfo As %ZEN.Auxiliary.QueryInfo) as %Boolean
Method for executing the compare show plans query when it is run in the background
• classmethod JobComparePlans(query, idList) as %ZEN.proxyObject [ ZenMethod ]
Method to job off Compare Show Plan process in the background.
• classmethod JobPossiblePlans(query) as %ZEN.proxyObject [ ZenMethod ]
Method to job off Show Plan process in the background.
• 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, rtn="") as %String [ ZenMethod ]
• method adjustSizes() [ Language = javascript ]
• method doClearQueryText() [ Language = javascript ]
• method doComparePlans() [ Language = javascript ]
• method doGetPlans() [ Language = javascript ]
Invoke method to gather SQL Statements and update SQL Statement Count table. During this time, disable the rasio buttons.
• method doHistory() [ Language = javascript ]
• method doShowPlan(ID, stats) [ 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 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.
• classmethod possiblePlansClose(ByRef qHandle As %Binary) as %Status
• classmethod possiblePlansExecute(ByRef qHandle As %Binary, JobID As %String) as %Status
• classmethod possiblePlansFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• classmethod possiblePlansStatsClose(ByRef qHandle As %Binary) as %Status
• classmethod possiblePlansStatsExecute(ByRef qHandle As %Binary, JobID As %String) as %Status
• classmethod possiblePlansStatsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• method selectHistory(tID) [ Language = javascript ]
This method processes actions for a query history item.
• method timeout() [ Language = javascript ]
• method toggleFields(hideflag) [ Language = javascript ]

Queries

• query possiblePlans(JobID As %String)
Selects ID As %Integer, Cost As %Integer, MapType As %String(MAXLEN=15), StartingMap As %String(MAXLEN=30), Plan As %String(MAXLEN=15)
This query uses %AltPlan array generated from possiblePlans run in the background
• query possiblePlansStats(JobID As %String)
Selects ID As %Integer, Cost As %Integer, StartingMap As %String, GlobalRef As %Integer, Commands As %Integer, TotalTime As %Integer, RowsReturned As %Integer, Plan As %String
This query uses %AltPlan array generated from possiblePlans run in the background


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