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

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

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
5 5 27


Summary

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

Properties
%condition %import %includeFiles %page
%resource FirstFailed HelpAddress ISREADONLY
InvalidParam IsEMSReadOnly IsEditForm LocatorHeader
NAMESPACE OnclickArray OpenDetailsPage PID
ParentURL SQLHomePage SaveQueryOutputPage StdTitle
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 msgWRC 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 %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 ClearClick 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
JobSaveQuery JobShowPlan Link OnDrawRibbon
OnGetRibbonInfo OnHTTPHeader OnPage OnPageError
OnPostHTTP OnPostHyperEvent OnPreHTTP OnPreHyperEvent
Page PrepareShowPlan PurgeQuery QuoteJS
RegisterRecent RemoveRow RewriteURL SaveClick
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL WRCRowExists XMLDTD
XMLExport XMLExportToStream XMLExportToString XMLNew
XMLSchema XMLSchemaNamespace XMLSchemaType addChild
addChildAfter addChildBefore adjustSizes afterSave
afterValidate cancelPopup changePassword checkWRCResult
childrenMutated correctIELayering createComponent createComponentNS
deleteComponent disableCommandButton doCancel doClear
doClearQueryText doGenerate doModified doSave
doSelectRow 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 getSelectedList getSettingMessages
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPToolsPage gotoPage
hideCommandButton invokeSuper isButtonDisabled isOfType
launchPopupWindow logout makeId 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 refreshTable removeChild render
renderContents renderSVG resetMsg searchBlur
searchBoxHandler searchFocus searchKeyDown searchKeyPress
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 validateWRCNum


Parameters

• parameter AUTONS = 1;
Switch namespace $NAMESPACE is present
• parameter CSPURL = "/csp/sys/exp/%CSP.UI.Portal.SQL.QButtons.ReportGenerator.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,Generate SQL Troubleshooting Report";
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

Properties

• property NAMESPACE as %ZEN.Datatype.string(ZENURL="$NAMESPACE");
local namespace property. Set to $NAMESPACE is present.
• property OpenDetailsPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/exp/%25CSP.UI.Portal.SQL.QButtons.OpenDetails.cls",,1) ];
• property SaveQueryOutputPage as %ZEN.Datatype.string [ InitialExpression = $P(..Link("%25CSP.UI.Portal.SQL.QButtons.SaveQueryOutput.zen"),"?$NAMESPACE",1) ];
• property ViewProcessPage as %ZEN.Datatype.string [ InitialExpression = ..Link("/csp/sys/op/%25CSP.UI.Portal.ProcessDetails.zen",,1) ];
• 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.") ];

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.
• 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 ]
• method adjustSizes() [ Language = javascript ]
• method 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.
• method 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.
• method doClearQueryText() [ Language = javascript ]
• method doGenerate() [ Language = javascript ]
• method doSave() [ Language = javascript ]
• method doSelectRow() [ Language = javascript ]
• method doViewProcess() [ Language = javascript ]
View details of a background process for Show Plan
• method getSelectedList() [ Language = javascript ]
• 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 onloadHandler() [ Language = javascript ]
This client event, if present, is fired when the page is loaded.
• method openDetails(PID) [ Language = javascript ]
Show Plan and other details on a separate tab
• method refreshTable() [ Language = javascript ]
• method timeout() [ Language = javascript ]
This function is executed when SaveQuery is processed to run in the background.
• method toggleFields(hideflag) [ Language = javascript ]
• method validateWRCNum() as %Boolean [ Language = javascript ]


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