Class Reference
%CSP.UI.Portal.SQL.QButtons.Utils
Server:appadmin-00044-deployment-6bf4cbc86d-9f4xc
Instance:IRIS
User:SuperUser
 
-
  [USER] >  [%CSP] >  [UI] >  [Portal] >  [SQL] >  [QButtons] >  [Utils]
Private  Storage

abstract class %CSP.UI.Portal.SQL.QButtons.Utils

This class contains shared methods used by the QButtons UI pages.

Inventory

Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 1 16


Summary

Properties
SQLHomePage

Methods
CheckJobStatus DrawUpto40Text GetImportSchema GetIndexAnalyzerProperties
GetQueryData GetQueryHistoryText GetQueryText GetSQLPageData
GetSettingsData GetSettingsInfo JobShowPlan PrepareShowPlan
PurgeQuery getSettingMessages gotoPToolsPage toggleClearText

Subclasses
%CSP.UI.Portal.SQL.QButtons.IndexAnalyzer %CSP.UI.Portal.SQL.QButtons.OpenDetails %CSP.UI.Portal.SQL.QButtons.ReportGenerator
%CSP.UI.Portal.SQL.QButtons.ReportLoader %CSP.UI.Portal.SQL.QButtons.RuntimeStats %CSP.UI.Portal.SQL.QButtons.RuntimeStatsDetails
%CSP.UI.Portal.SQL.QButtons.RuntimeStatsSettings %CSP.UI.Portal.SQL.QButtons.ShowPlanAlt

Parameters

• parameter DOMAIN = "%Utility";

Properties

• property SQLHomePage as %ZEN.Datatype.string [ InitialExpression = ..Link("%25CSP.UI.Portal.SQL.Home.zen") ];

Methods

• classmethod CheckJobStatus(PID) as %ZEN.proxyObject [ ZenMethod ]
• method DrawUpto40Text(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
Write upto 40 characters of any field in tablePane
• classmethod GetImportSchema(pNamespace, pRoutine, pCursor, pInternal=0) as %String [ ZenMethod ]
• classmethod GetIndexAnalyzerProperties(Output pObject As %ZEN.proxyObject) as %Status
This method returns proxyObject that contains information for the UI
• classmethod GetQueryData(pNamespace, pCursorName, pRoutineName, Output pObject As %ZEN.proxyObject) as %Status
This method returns information regarding a cached query for the UI.
• classmethod GetQueryHistoryText(pID) as %String [ ZenMethod ]
Given a history ID, return query text
• classmethod GetQueryText(pNamespace, pRoutine, pCursor, pInternal=0) as %String [ ZenMethod ]
Return PTools SQL Stats Query Text
• classmethod GetSQLPageData(Output pObject As %ZEN.proxyObject) as %Status
Return json data for SQL page
• classmethod GetSettingsData(Output pObject As %ZEN.proxyObject) as %Status
This method returns information regarding view stats settings for the UI.
• method GetSettingsInfo(ByRef pParms, Output pObject As %RegisteredObject) as %Status
Return server info per View Stats.
• classmethod JobShowPlan(query) as %ZEN.proxyObject [ ZenMethod ]
Method to job off Show Plan process in the background.
• classmethod PrepareShowPlan(query, schema="", id="") as %String [ ZenMethod ]
• classmethod PurgeQuery(pNamespace) as %ZEN.proxyObject [ ZenMethod ]
This method returns 1 (success) or 0 and clears cached queries.
• method getSettingMessages(json) [ Language = javascript ]
Returns display messages for settings json should be passed in containing the settings data
• method gotoPToolsPage(pageId) [ Language = javascript ]
Goto a particular page
• method toggleClearText(tControl) [ Language = javascript ]
show or hide the Clear image for Query Text or Filter


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