Skip to main content


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

Property Inventory

Method Inventory


parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.ShowPlanAlt.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 Alternate Show Plans;
Inherited description: 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;
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 COMPAREROWS as %ZEN.Datatype.string;
Property methods: COMPAREROWSDisplayToLogical(), COMPAREROWSGet(), COMPAREROWSIsValid(), COMPAREROWSLogicalToDisplay(), COMPAREROWSLogicalToOdbc(), COMPAREROWSNormalize(), COMPAREROWSSet()
property IsCompare as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Whether the current background job is for compare show plan
Property methods: IsCompareDisplayToLogical(), IsCompareGet(), IsCompareIsValid(), IsCompareLogicalToDisplay(), IsCompareLogicalToOdbc(), IsCompareLogicalToXSD(), IsCompareNormalize(), IsCompareSet(), IsCompareXSDToLogical()
property JOBID as %ZEN.Datatype.integer;
Property methods: JOBIDDisplayToLogical(), JOBIDGet(), JOBIDIsValid(), JOBIDLogicalToDisplay(), JOBIDLogicalToOdbc(), JOBIDNormalize(), JOBIDSet()
property PlanPage as %String;
Property methods: PlanPageDisplayToLogical(), PlanPageGet(), PlanPageIsValid(), PlanPageLogicalToDisplay(), PlanPageLogicalToOdbc(), PlanPageNormalize(), PlanPageSet()
property QUERYCLASS as %ZEN.Datatype.string [ InitialExpression = "%CSP.UI.Portal.SQL.QButtons.ShowPlanAlt" ];
Property methods: QUERYCLASSDisplayToLogical(), QUERYCLASSGet(), QUERYCLASSIsValid(), QUERYCLASSLogicalToDisplay(), QUERYCLASSLogicalToOdbc(), QUERYCLASSNormalize(), QUERYCLASSSet()
property QUERYNAME as %ZEN.Datatype.string [ InitialExpression = "possiblePlans" ];
Property methods: QUERYNAMEDisplayToLogical(), QUERYNAMEGet(), QUERYNAMEIsValid(), QUERYNAMELogicalToDisplay(), QUERYNAMELogicalToOdbc(), QUERYNAMENormalize(), QUERYNAMESet()
property QUERYTEXT as %ZEN.Datatype.string;
Property methods: QUERYTEXTDisplayToLogical(), QUERYTEXTGet(), QUERYTEXTIsValid(), QUERYTEXTLogicalToDisplay(), QUERYTEXTLogicalToOdbc(), QUERYTEXTNormalize(), QUERYTEXTSet()
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()


Return the array of links to show in the locator bar.
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 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 As %Library.String, rtn As %Library.String = "", id As %Library.String = "") as %String [ ZenMethod ]
clientmethod adjustSizes() [ Language = javascript ]
clientmethod doClearQueryText() [ Language = javascript ]
clientmethod doComparePlans() [ Language = javascript ]
clientmethod doGetPlans() [ Language = javascript ]
Invoke method to gather SQL Statements and update SQL Statement Count table. During this time, disable the rasio buttons.
clientmethod doHistory() [ Language = javascript ]
clientmethod doShowPlan(ID, stats) [ 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 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.
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
clientmethod selectHistory(tID) [ Language = javascript ]
This method processes actions for a query history item.
clientmethod timeout() [ Language = javascript ]
clientmethod toggleFields(hideflag) [ Language = javascript ]


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

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab