This is documentation for Caché & Ensemble.

For information on converting to InterSystems IRIS, see the InterSystems IRIS Adoption Guide and the InterSystems IRIS In-Place Conversion Guide, both available on the WRC Distributions page (login required).

Home > Class Reference > ENSLIB namespace > EnsPortal.ProductionMonitor

EnsPortal.ProductionMonitor

class EnsPortal.ProductionMonitor extends EnsPortal.Template.viewerPage

This page displays monitoring information for the current running production.

Property Inventory

Method Inventory

Parameters

parameter PAGENAME = Production Monitor;
Displayed name of this page.
parameter RESOURCE = %Ens_Dashboard:USE;
User needs USE permissions on the %Ens_Dashboard resource to access this page.
parameter SHOWSEARCHTOGGLE = 0;
Indicate whether toggle button for search pane should be displayed.

Properties

property allowedCategories as %String (ZENURL = "CATEGORIES");
URL parameter specifying list of visible categories
Property methods: allowedCategoriesDisplayToLogical(), allowedCategoriesGet(), allowedCategoriesIsValid(), allowedCategoriesLogicalToDisplay(), allowedCategoriesLogicalToOdbc(), allowedCategoriesNormalize(), allowedCategoriesSet()
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 canQueryEvents as %Boolean [ InitialExpression = 1 ];
Property methods: canQueryEventsDisplayToLogical(), canQueryEventsGet(), canQueryEventsIsValid(), canQueryEventsLogicalToDisplay(), canQueryEventsLogicalToXSD(), canQueryEventsNormalize(), canQueryEventsSet(), canQueryEventsXSDToLogical()
property canQueryMessages as %Boolean [ InitialExpression = 1 ];
Property methods: canQueryMessagesDisplayToLogical(), canQueryMessagesGet(), canQueryMessagesIsValid(), canQueryMessagesLogicalToDisplay(), canQueryMessagesLogicalToXSD(), canQueryMessagesNormalize(), canQueryMessagesSet(), canQueryMessagesXSDToLogical()
property canUpdateProduction as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList("%Ens_ProductionRun:USE,%Ens_ConfigItemRun:USE") ];
Property methods: canUpdateProductionDisplayToLogical(), canUpdateProductionGet(), canUpdateProductionIsValid(), canUpdateProductionLogicalToDisplay(), canUpdateProductionLogicalToXSD(), canUpdateProductionNormalize(), canUpdateProductionSet(), canUpdateProductionXSDToLogical()
property canViewEvents as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.EventLog).#RESOURCE) ];
Property methods: canViewEventsDisplayToLogical(), canViewEventsGet(), canViewEventsIsValid(), canViewEventsLogicalToDisplay(), canViewEventsLogicalToXSD(), canViewEventsNormalize(), canViewEventsSet(), canViewEventsXSDToLogical()
property canViewProduction as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.ProductionConfig).#RESOURCE) ];
Property methods: canViewProductionDisplayToLogical(), canViewProductionGet(), canViewProductionIsValid(), canViewProductionLogicalToDisplay(), canViewProductionLogicalToXSD(), canViewProductionNormalize(), canViewProductionSet(), canViewProductionXSDToLogical()
property canViewQueues as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.Queues).#RESOURCE) ];
Property methods: canViewQueuesDisplayToLogical(), canViewQueuesGet(), canViewQueuesIsValid(), canViewQueuesLogicalToDisplay(), canViewQueuesLogicalToXSD(), canViewQueuesNormalize(), canViewQueuesSet(), canViewQueuesXSDToLogical()
property canViewSearch as %Boolean [ InitialExpression = 0 ];
Property methods: canViewSearchDisplayToLogical(), canViewSearchGet(), canViewSearchIsValid(), canViewSearchLogicalToDisplay(), canViewSearchLogicalToXSD(), canViewSearchNormalize(), canViewSearchSet(), canViewSearchXSDToLogical()
property canViewSuspended as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.SuspendedMsg).#RESOURCE) ];
Property methods: canViewSuspendedDisplayToLogical(), canViewSuspendedGet(), canViewSuspendedIsValid(), canViewSuspendedLogicalToDisplay(), canViewSuspendedLogicalToXSD(), canViewSuspendedNormalize(), canViewSuspendedSet(), canViewSuspendedXSDToLogical()
property currCategory as %String;
Current selected Category.
Property methods: currCategoryDisplayToLogical(), currCategoryGet(), currCategoryIsValid(), currCategoryLogicalToDisplay(), currCategoryLogicalToOdbc(), currCategoryNormalize(), currCategorySet()
property detailsWidth as %ZEN.Datatype.integer (MAXVAL = 80, MINVAL = 5) [ InitialExpression = 60 ];
Width of details pane
Property methods: detailsWidthDisplayToLogical(), detailsWidthGet(), detailsWidthIsValid(), detailsWidthLogicalToDisplay(), detailsWidthLogicalToOdbc(), detailsWidthNormalize(), detailsWidthSet()
property filteredErrCount as %Integer [ InitialExpression = 0 ];
Property methods: filteredErrCountDisplayToLogical(), filteredErrCountGet(), filteredErrCountIsValid(), filteredErrCountLogicalToDisplay(), filteredErrCountNormalize(), filteredErrCountSet(), filteredErrCountXSDToLogical()
property filteredItemCount as %Integer [ InitialExpression = 0 ];
Number of items not shown due to category filtering
Property methods: filteredItemCountDisplayToLogical(), filteredItemCountGet(), filteredItemCountIsValid(), filteredItemCountLogicalToDisplay(), filteredItemCountNormalize(), filteredItemCountSet(), filteredItemCountXSDToLogical()
property frameHeight as %ZEN.Datatype.integer (ZENURL = "FRAMEHEIGHT") [ InitialExpression = 0 ];
Property methods: frameHeightDisplayToLogical(), frameHeightGet(), frameHeightIsValid(), frameHeightLogicalToDisplay(), frameHeightLogicalToOdbc(), frameHeightNormalize(), frameHeightSet()
property frameWidth as %ZEN.Datatype.integer (ZENURL = "FRAMEWIDTH") [ InitialExpression = 0 ];
Dimensions of frame in which this page is displayed (if any)
Property methods: frameWidthDisplayToLogical(), frameWidthGet(), frameWidthIsValid(), frameWidthLogicalToDisplay(), frameWidthLogicalToOdbc(), frameWidthNormalize(), frameWidthSet()
property isEmbedded as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: isEmbeddedDisplayToLogical(), isEmbeddedGet(), isEmbeddedIsValid(), isEmbeddedLogicalToDisplay(), isEmbeddedLogicalToOdbc(), isEmbeddedLogicalToXSD(), isEmbeddedNormalize(), isEmbeddedSet(), isEmbeddedXSDToLogical()
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()
property msgGoToMessageViewer as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Message Viewer") ];
display text
Property methods: msgGoToMessageViewerDisplayToLogical(), msgGoToMessageViewerGet(), msgGoToMessageViewerIsValid(), msgGoToMessageViewerLogicalToDisplay(), msgGoToMessageViewerLogicalToOdbc(), msgGoToMessageViewerNormalize(), msgGoToMessageViewerSet()
property productionId as %String [ InitialExpression = ..GetCurrentProduction() ];
ID of Production to display.
Property methods: productionIdDisplayToLogical(), productionIdGet(), productionIdIsValid(), productionIdLogicalToDisplay(), productionIdLogicalToOdbc(), productionIdNormalize(), productionIdSet()
property sortMode as %String [ InitialExpression = "Id" ];
Sorting mode: name or id
Property methods: sortModeDisplayToLogical(), sortModeGet(), sortModeIsValid(), sortModeLogicalToDisplay(), sortModeLogicalToOdbc(), sortModeNormalize(), sortModeSet()

Methods

method %OnAfterCreatePage() as %Status
Get the frameWidth, frameHeight allowedCategoriesURL parameters, if specified
method %OnGetPageName() as %String
Get the (localized) name of the page. This should be implemented in a subclass.
method %OnGetTitle() as %String
Get the (localized) title string for the page. This should be implemented in a subclass.
classmethod CallEnabler(tItem As %String, tSetting As %Boolean) [ ZenMethod ]
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 DrawDiagramHeader(pSeed As %String) as %Status
Draw top portion of results pane.
method DrawInfoTable(pCategory As %String, ByRef pInfo, pTitle As %String, ByRef pSummary, pCellHeight As %Integer = 200, seed As %ZEN.Datatype.string) 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.
method FormatDateTime(table As %ZEN.Component.tablePane, dt As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Method to get the Date or Time piece from the TimeCreated field.
classmethod GetCurrentProduction() as %String
Choose which Production to start with.
method GetElapsedTime(pOldTime As %String, Output pElapsedTime As %String) as %Status
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.Monitor.Settings global. This takes the following form:
   Set ^Ens.Monitor.Settings("MetricClasses",1,"Metric") = NameOfMetric
   Set ^Ens.Monitor.Settings("MetricClasses",1,"Title") = TitleToDisplay
   Set ^Ens.Monitor.Settings("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 OnGetRibbonInfo(Output pDisplay As %Library.Boolean, Output pViewIcons As %Library.List, Output pSortOptions As %Library.List, Output pSearchBox As %Library.Boolean, Output pRibbonTitle As %Library.String, Output pCommands As %Library.List) as %Status
Inherited description: Get information to display in the ribbon bar.
method ShowElapsedTime(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
method TruncateMessageText(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status
clientmethod adjustSizes() [ Language = javascript ]
Adjust sizes of components on the page.
clientmethod disableItem(tProduction, tItem) [ Language = javascript ]
clientmethod enableItem(tProduction, tItem) [ Language = javascript ]
method getItemRetryCount(itemName As %String) as %Integer [ ZenMethod ]
Update retryCount, recent error messages, etc.
method getTimeSinceLastActivity(pItemName As %String) as %String [ ZenMethod ]
clientmethod gotoMessageViewer() [ Language = javascript ]
clientmethod onServerMethodError(err, errObject) [ Language = javascript ]
Intercept xmlHTTP errors and reload page rather than putting up alert box.
clientmethod onlayoutHandler(load) [ Language = javascript ]
This client event is fired when the page is resized.
clientmethod onresizeHandler(load) [ Language = javascript ]
This client event is fired when the page is resized.
clientmethod selectCategory(cat) [ Language = javascript ]
User selected a category for the diagram.
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 setSortMode(mode) [ Language = javascript ]
Inherited description: Change the current sort mode for the page.
clientmethod updateDetails(timer) [ Language = javascript ]
Update the details pane.
clientmethod updateFilteredCount(ctr, errCtr) [ Language = javascript ]
clientmethod updateMessages(hostName) [ Language = javascript ]
Update the messages table for the given host item.
clientmethod updateMonitor(timer) [ Language = javascript ]
Update the monitor pane.

Inherited Members

Inherited Properties

Inherited Methods

FeedbackOpens in a new window