Learning
Documentation
Community
Open Exchange
Global Masters
Home / Class Reference / ENSLIB namespace / CSPX.Portal.Monitor
Private  Storage   

CSPX.Portal.Monitor


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

This page displays monitoring information for the current running production.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
2 4 16


Summary


This is a Zen Page class. It belongs to the application CSPX.Portal.Application.

Properties
%condition %import %includeFiles %page
%resource StdTitle align autoUpdate
aux backgroundTimerInterval cellAlign cellSize
cellStyle cellVAlign children composite
containerStyle cssLevel disabled dragAndDrop
dragEnabled dropEnabled enclosingClass enclosingStyle
error groupClass groupStyle height
hidden hint hintClass hintStyle
id index label labelClass
labelDisabledClass labelPosition labelStyle lastUpdate
layout monitorHeight monitorWidth name
onafterdrag onbeforedrag onclick ondrag
ondrop onhide onrefresh onshow
onupdate parent 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 %GetLinks
%GetNamespaces %GetPageName %GetParameter %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
%OnMonitorBackgroundTask %OnMutateChildren %OnObjectSynch %OnPreHTTP
%OnSubmit %OnUseSoftModals %OnZENDeserialize %OriginalNamespace
%PackageName %QuoteValue %QuoteValueL10N %RemoveChild
%RemoveChildren %RemoveComponent %RemoveFromSaveSet %RunBackgroundMethod
%Self %SerializeObject %SetBackgroundMethodStatus %SetErrorById
%SetErrorByName %SetModified %SetValueById %SetValueByName
%SetValuesByName %StartScript %ValidateObject %ZENVersion
ConvertParameter Decrypt DrawDetails DrawInfoTable
DrawMonitorInfo DrawTitle Encrypt EscapeHTML
EscapeURL GetEventLogInfo GetHostInfo GetQueueInfo
GetQuickLinks GetUserMetricClasses GetUserMetricInfo HyperEventCall
HyperEventHead Include InsertHiddenField InsertHiddenFields
IsPrivate Link OnHTTPHeader OnPage
OnPageError OnPostHTTP OnPostHyperEvent OnPreHTTP
OnPreHyperEvent Page QuoteJS RewriteURL
ShowError StartTimer StopTimer ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore arrowClick cancelPopup childrenMutated
correctIELayering createComponent createComponentNS deleteComponent
dragFinishHandler dragHandler dragNotifyHandler dragStartHandler
dropHandler dropStartHandler endModal exposeComponent
findElement fireOnResizeEvent fireOnUnloadEvent fireOnUpdateEvent
firePopupAction getChildIndex getComponent getComponentById
getEnclosingDiv getHidden getHintElement getLabelElement
getOpener getProperty getSettings getType
gotoPage invokeSuper isOfType launchPopupWindow
makeId onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
ondisabledHandler onkeydownHandler onkeyupHandler onlayoutHandler
onloadHandler onlogoutHandler onoverlayHandler onresizeHandler
onunloadHandler onupdateHandler popupActionHandler refreshContents
removeChild render renderContents renderSVG
selectItem setAutoUpdate setComponentId setHidden
setLastUpdate setOverlayMode setProperty setPropertyAll
setTraceOption showDocumentation startModal startProgressBar
stopProgressBar updateMonitor


Parameters


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

Properties


• property autoUpdate as %ZEN.Datatype.boolean [ InitialExpression = 1 ];
Indicates whether auto-update is enabled.
• property lastUpdate as %ZEN.Datatype.string [ InitialExpression = $$$timeLocal ];
Time of last update
• property monitorHeight as %ZEN.Datatype.integer;
Used to pass size information to the server.
• property monitorWidth as %ZEN.Datatype.integer;
Used to pass size information to the server.

Methods


• method %OnAfterCreatePage() as %Status
Set Locator bar and determine whether to show change password option.
• method DrawDetails(seed As %ZEN.Datatype.string) as %Status
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
Render HTML for one category of monitor info.
• method DrawMonitorInfo(seed As %ZEN.Datatype.string) as %Status
Acquire and display monitoring data as a series of tables.
• classmethod DrawTitle(pSeed As %String) as %Status
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
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
Get information about currently running hosts and place it into pInfo array.
• method GetQueueInfo(ByRef pInfo, ByRef pSummary) as %Status
Get information about currently running queues and place it into pInfo array under "Queues".
• method GetUserMetricClasses(Output pUserSettings)
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
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.
• method onServerMethodError(err) [ Language = javascript ]
Intercept xmlHTTP errors and reload page rather than putting up alert box.
• method 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.
• method selectItem(cat, id, name) [ Language = javascript ]
An item has been selected, show details for it.
• method setAutoUpdate(flag) [ Language = javascript ]
Set autoUpdate mode.
• method setLastUpdate(time) [ Language = javascript ]
Set the last update field. time is the last update time to display.
• method updateMonitor(timer) [ Language = javascript ]
Update the monitor pane.