Home > Class Reference > ENSLIB namespace > CSPX.Portal.Monitor


class CSPX.Portal.Monitor extends CSPX.Portal.Template

This page displays monitoring information for the current running production.

Property Inventory

Method Inventory


parameter APPLICATION = CSPX.Portal.Application;
Class name of application this page belongs to.
parameter PAGENAME = System Monitor;
Displayed name of this page.


property autoUpdate as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Indicates whether auto-update is enabled.
Property methods: autoUpdateDisplayToLogical(), autoUpdateGet(), autoUpdateIsValid(), autoUpdateLogicalToDisplay(), autoUpdateLogicalToOdbc(), autoUpdateLogicalToXSD(), autoUpdateNormalize(), autoUpdateSet(), autoUpdateXSDToLogical()
property lastUpdate as %ZEN.Datatype.string [ InitialExpression = $$$timeLocal ];
Time of last update
Property methods: lastUpdateDisplayToLogical(), lastUpdateGet(), lastUpdateIsValid(), lastUpdateLogicalToDisplay(), lastUpdateLogicalToOdbc(), lastUpdateNormalize(), lastUpdateSet()
property monitorHeight as %ZEN.Datatype.integer;
Used to pass size information to the server.
Property methods: monitorHeightDisplayToLogical(), monitorHeightGet(), monitorHeightIsValid(), monitorHeightLogicalToDisplay(), monitorHeightLogicalToOdbc(), monitorHeightNormalize(), monitorHeightSet()
property monitorWidth as %ZEN.Datatype.integer;
Used to pass size information to the server.
Property methods: monitorWidthDisplayToLogical(), monitorWidthGet(), monitorWidthIsValid(), monitorWidthLogicalToDisplay(), monitorWidthLogicalToOdbc(), monitorWidthNormalize(), monitorWidthSet()


method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Set Locator bar and determine whether to show change password option.
method DrawDetails(seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
Draw contents of details region. pSeed contains category~id~name (~ is a delimiter) for the selected item.
method DrawInfoTable(pCategory As %String, ByRef pInfo, pTitle As %String, ByRef pSummary, pCols As %Integer = 2, pShowDetail As %Boolean = 0, pDetailTitle As %String = "", pCellHeight As %Integer = 200) as %Status [ Language = objectscript ]
Render HTML for one category of monitor info.
method DrawMonitorInfo(seed As %ZEN.Datatype.string) as %Status [ Language = objectscript ]
Acquire and display monitoring data as a series of tables.
classmethod DrawTitle(pSeed As %String) as %Status [ Language = objectscript ]
Used to draw title for this page. pHelpAddress is need to build the link for Help for this page.
method GetEventLogInfo(ByRef pInfo, ByRef pSummary) as %Status [ Language = objectscript ]
Get information about top items within the Event Log and place it into pInfo array under "EventLog"
method GetHostInfo(ByRef pInfo, ByRef pSummary) as %Status [ Language = objectscript ]
Get information about currently running hosts and place it into pInfo array.
method GetQueueInfo(ByRef pInfo, ByRef pSummary) as %Status [ Language = objectscript ]
Get information about currently running queues and place it into pInfo array under "Queues".
method GetUserMetricClasses(Output pUserSettings) [ Language = objectscript ]
Return a list of Business Metric classes that serve up user dashboard information.
The list of Business Metrics is determined by looking at the ^Ens.MonitorSettings global. This takes the following form:
   Set ^Ens.MonitorSettings("MetricClasses",1,"Metric") = NameOfMetric
   Set ^Ens.MonitorSettings("MetricClasses",1,"Title") = TitleToDisplay
   Set ^Ens.MonitorSettings("MetricClasses",1,"Instance") = MetricInstance // (optional)
Additional metrics would use a higher second subscript.
method GetUserMetricInfo(pMetric As %String, ByRef pInfo, ByRef pSummary, pMetricInstance As %String) as %Status [ Language = objectscript ]
Get information from the given business metric cache and place it into pInfo array.
If pMetricInstance is supplied, then it specifies the metric instance to use, otherwise the first (or only) one is used.
clientmethod onServerMethodError(err As %Library.String, errObject As %Library.String) [ Language = javascript ]
Intercept xmlHTTP errors and reload page rather than putting up alert box.
clientmethod 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.
clientmethod selectItem(cat, id, name) [ Language = javascript ]
An item has been selected, show details for it.
clientmethod setAutoUpdate(flag) [ Language = javascript ]
Set autoUpdate mode.
clientmethod setLastUpdate(time) [ Language = javascript ]
Set the last update field. time is the last update time to display.
clientmethod updateMonitor(timer) [ Language = javascript ]
Update the monitor pane.

Inherited Members

Inherited Properties

Inherited Methods