Skip to main content


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

System Management Portal - SQL Performance Tool - Troubleshooting Report Generator

Property Inventory

Method Inventory


parameter AUTONS = 1;
Switch namespace $NAMESPACE is present
parameter CSPURL = /csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.ReportGenerator.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,Generate SQL Troubleshooting Report;
Inherited description: Each SMP page should set this link which points to the documentation anchor name.
parameter PAGENAME = SQL QButtons Report Generator;
Displayed name of this page.
parameter RESOURCE = %Development;
Security requirement


property NAMESPACE as %ZEN.Datatype.string (ZENURL = "$NAMESPACE");
Inherited description: local namespace property. Set to $NAMESPACE is present.
Property methods: NAMESPACEDisplayToLogical(), NAMESPACEGet(), NAMESPACEIsValid(), NAMESPACELogicalToDisplay(), NAMESPACELogicalToOdbc(), NAMESPACENormalize(), NAMESPACESet()
property OpenDetailsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.Portal.SQL.QButtons.OpenDetails.cls",,1) ];
Property methods: OpenDetailsPageDisplayToLogical(), OpenDetailsPageGet(), OpenDetailsPageIsValid(), OpenDetailsPageLogicalToDisplay(), OpenDetailsPageLogicalToOdbc(), OpenDetailsPageNormalize(), OpenDetailsPageSet()
property SaveQueryOutputPage as %ZEN.Datatype.string [ InitialExpression = $P(..Link("%25CSP.UI.Portal.SQL.QButtons.SaveQueryOutput.zen"),"?$NAMESPACE",1) ];
Property methods: SaveQueryOutputPageDisplayToLogical(), SaveQueryOutputPageGet(), SaveQueryOutputPageIsValid(), SaveQueryOutputPageLogicalToDisplay(), SaveQueryOutputPageLogicalToOdbc(), SaveQueryOutputPageNormalize(), SaveQueryOutputPageSet()
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 msgWRC as %ZEN.Datatype.string [ InitialExpression = $$$Text("Please enter a WRC number that already exist in the table or select existing IDs from the table.") ];
Property methods: msgWRCDisplayToLogical(), msgWRCGet(), msgWRCIsValid(), msgWRCLogicalToDisplay(), msgWRCLogicalToOdbc(), msgWRCNormalize(), msgWRCSet()


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.
classmethod ClearClick(wrcnum As %String = "", selectedIDs As %String = "") as %ZEN.proxyObject [ ZenMethod ]
Clear data by WRC. If single wrcnum is passed in, clear that. If a list of selected IDs are passed in, clear each one in the list.
method DrawDetailsTitle(pId) as %Status
Draw html for details title: SQL Statement
method DrawQueryText(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Write upto 80 characters of query statement in tablePane
classmethod JobSaveQuery(query, WRCNum, includeresults) as %ZEN.proxyObject [ 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 RemoveRow(delId As %String) as %Integer [ ZenMethod ]
classmethod SaveClick(QueryText, WRCNum, includeresults) as %String [ ZenMethod ]
classmethod WRCRowExists(WRCNum) as %Boolean [ ZenMethod ]
clientmethod adjustSizes() [ Language = javascript ]
clientmethod checkWRCResult() as %Boolean [ Language = javascript ]
This method checked whether the WRC number user entered exists in the table The Generate button is disabled if it is the saved queries does not include the WRC.
clientmethod doClear() [ Language = javascript ]
If user selected one or more checkboxes, then get the WRC numbers from that Otherwise check to see if user entered a WRC number in the WRC Number field.
clientmethod doClearQueryText() [ Language = javascript ]
clientmethod doGenerate() [ Language = javascript ]
clientmethod doSave() [ Language = javascript ]
clientmethod doSelectRow() [ Language = javascript ]
clientmethod doViewProcess() [ Language = javascript ]
View details of a background process for Show Plan
clientmethod getSelectedList() [ 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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
clientmethod openDetails(PID) [ Language = javascript ]
Show Plan and other details on a separate tab
clientmethod refreshTable() [ Language = javascript ]
clientmethod timeout() [ Language = javascript ]
This function is executed when SaveQuery is processed to run in the background.
clientmethod toggleFields(hideflag) [ Language = javascript ]
clientmethod validateWRCNum() as %Boolean [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new tab