Class EnsPortal.ProductionMonitor

class EnsPortal.ProductionMonitor extends EnsPortal.Template.viewerPage

This page displays monitoring information for the current running production.

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	23	38

Summary

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

Properties
%condition	%import	%includeFiles	%page
%resource	HelpAddress	ISREADONLY	LocatorHeader
ParentURL	StdTitle	aboutPage	align
allowedCategories	autoUpdate	aux	backgroundTimerInterval
canEdit	canQueryEvents	canQueryMessages	canUpdateProduction
canViewEvents	canViewProduction	canViewQueues	canViewSearch
canViewSuspended	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	contactPage
containerStyle	cssLevel	currCategory	currSortMode
currStep	currViewMode	currentPage	currentPageStart
detailsHidden	detailsWidth	disabled	dragAndDrop
dragEnabled	dropEnabled	enableAutoRefresh	enclosingClass
enclosingStyle	error	filteredErrCount	filteredItemCount
frameHeight	frameWidth	groupClass	groupStyle
height	hidden	hideDetailsMsg	hideSearchMsg
hint	hintClass	hintStyle	home
homePage	id	index	isEmbedded
isFirstPage	isLastPage	keepAliveInterval	label
labelClass	labelDisabledClass	labelPosition	labelStyle
lastUpdate	layout	lblDetails	lblTitle
limitPopups	monitorHeight	monitorWidth	msgCloseDetail
msgGoToMessageViewer	msgNotPermitted	name	onafterdrag
onbeforedrag	onclick	ondrag	ondrop
onhide	onrefresh	onshow	onupdate
pageId	pageModified	pageNumberId	pageSizeId
parent	productionId	queryAtEnd	resultsTableId
searchCriteria	searchJob	searchKey	searchQuery
selectedId	showDetailsMsg	showLabel	showSearchMsg
slice	sortMode	tablePaneUsesSQLAttrib	tempPortalNode
title	tuple	useSVG	useSoftModals
valign	visible	width	window
zenPersistentPopup

Methods
%AddCSPShareHyperevents	%AddChild	%AddChildAfter	%AddChildBefore
%AddComponent	%AddEnsExceptionHandler	%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
%GetRootLink	%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	%OnGetTableLinkMenu	%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	CallEnabler	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	ConvertParameter	Decrypt	DoLogout
DrawDetails	DrawDetailsContent	DrawDiagramHeader	DrawInfoTable
DrawLocator	DrawMonitorInfo	DrawRibbon	DrawTitle
Encrypt	EscapeHTML	EscapeURL	EvalResult
FormatDateTime	GetCSPURL	GetColumnsAndFrom	GetContextLinks
GetCurrentProduction	GetDocURL	GetElapsedTime	GetEventLogInfo
GetHomePage	GetHostInfo	GetHyperEventResources	GetNewURL
GetQueueInfo	GetQuickLinks	GetRemoteSearchJob	GetUserMetricClasses
GetUserMetricInfo	HyperEventCall	HyperEventHead	Include
InsertHiddenField	InsertHiddenFields	IsPrivate	JavaInstalled
Link	OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP	OnPostHyperEvent
OnPreHTTP	OnPreHyperEvent	Page	PrepareCancel
QuoteJS	RegisterRecent	RemoveTempData	ResetQuery
RewriteURL	ShowElapsedTime	ShowError	SignalCancel
SimpleKeepAlive	StartTimer	StopTimer	ThrowError
TruncateMessageText	UnescapeHTML	UnescapeURL	XMLDTD
XMLExport	XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType	addChild
addChildAfter	addChildBefore	addPopupSuffix	adjustExpanderText
adjustSizes	arrowClick	cancelPopup	cancelSearch
changePassword	changeURLNamespace	checkEdit	childrenMutated
clientKeepAlive	correctIELayering	createComponent	createComponentNS
createTimeWarning	deleteComponent	disableCommandButton	disableItem
displayCountDown	doSearch	doUpdateAll	dragFinishHandler
dragHandler	dragNotifyHandler	dragStartHandler	dropHandler
dropStartHandler	enableCommandButton	enableItem	endModal
executeSearch	exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction	getChildIndex
getComponent	getComponentById	getContentAreaHeight	getEnclosingDiv
getHidden	getHintElement	getItemRetryCount	getLabelElement
getNextData	getOpener	getPageTitle	getProperty
getResultsTable	getSearchForm	getSettings	getTimeSinceLastActivity
getTitleAreaHeight	getType	goHome	goMenu
gotoMessageViewer	gotoNamespace	gotoPage	hideCommandButton
hideTimeoutWarning	hideWarnContinue	inResizeLoop	indicateIfCancelled
initPopupSuffix	invokeSuper	isOfType	launchPopupWindow
logout	makeId	manualKeepAlive	navigate
onAfterPageChange	onAfterSearch	onChangeResultsPage	onCreate
onDelete	onDisplayHandler	onEndModalHandler	onEnsException
onPopupAction	onRefreshContents	onSearchHandler	onSelectItem
onSerialize	onServerMethodCall	onServerMethodError	onServerMethodReturn
onStartModalHandler	onToggleDetails	onToggleSearch	ondisabledHandler
onhandleAutoLogoutWarn	onkeydownHandler	onkeyupHandler	onlayoutHandler
onloadHandler	onlogoutHandler	onoverlayHandler	onresizeHandler
onunloadHandler	onupdateHandler	popupActionHandler	refreshContents
removeChild	removePopupSuffix	render	renderContents
renderSVG	searchBlur	searchBoxHandler	searchFocus
searchKeyDown	searchKeyPress	selectCategory	selectItem
setAutoUpdate	setComponentId	setConnectivityStatusMsg	setHidden
setLastUpdate	setModified	setOverlayMode	setPageTitle
setProperty	setPropertyAll	setSortMode	setSortModeHandler
setTraceOption	setViewMode	setViewModeHandler	setWarnInnerHTML
showAbout	showCommandButton	showContact	showDocumentation
showHelp	showQuery	showTimeoutWarning	startKeepAlive
startModal	startProgressBar	stopKeepAlive	stopProgressBar
switchNamespace	toggleCancelState	toggleDetails	toggleSearch
toggleSearchState	updateDetails	updateFilteredCount	updateMessages
updateMonitor	updateNavigationButtons	updatePageData	updatePageNumber
updatePageSize	warnclickListener

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 autoUpdate as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

Indicates whether auto-update is enabled.

• property canQueryEvents as %Boolean [ InitialExpression = 1 ];

• property canQueryMessages as %Boolean [ InitialExpression = 1 ];

• property canUpdateProduction as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList("%Ens_ProductionRun:USE,%Ens_ConfigItemRun:USE") ];

• property canViewEvents as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.EventLog).#RESOURCE) ];

• property canViewProduction as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.ProductionConfig).#RESOURCE) ];

• property canViewQueues as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.Queues).#RESOURCE) ];

• property canViewSearch as %Boolean [ InitialExpression = 0 ];

• property canViewSuspended as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(EnsPortal.SuspendedMsg).#RESOURCE) ];

• property currCategory as %String;

Current selected Category.

• property detailsWidth as %ZEN.Datatype.integer(MAXVAL=80,MINVAL=5) [ InitialExpression = 60 ];

Width of details pane

• property filteredErrCount as %Integer [ InitialExpression = 0 ];

• property filteredItemCount as %Integer [ InitialExpression = 0 ];

Number of items not shown due to category filtering

• property frameHeight as %ZEN.Datatype.integer(ZENURL="FRAMEHEIGHT") [ InitialExpression = 0 ];

• property frameWidth as %ZEN.Datatype.integer(ZENURL="FRAMEWIDTH") [ InitialExpression = 0 ];

Dimensions of frame in which this page is displayed (if any)

• property isEmbedded as %ZEN.Datatype.boolean [ InitialExpression = 0 ];

• 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.

• property msgGoToMessageViewer as %ZEN.Datatype.caption [ InitialExpression = $$$TextJS("Go To Message Viewer") ];

display text

• property productionId as %String [ InitialExpression = ..GetCurrentProduction() ];

ID of Production to display.

• property sortMode as %String [ InitialExpression = "Id" ];

Sorting mode: name or id

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 %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String) as %Status

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

• method adjustSizes() [ Language = javascript ]

Adjust sizes of components on the page.

• method disableItem(tProduction, tItem) [ Language = javascript ]

• method doUpdateAll() [ Language = javascript ]

• method 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 ]

• method gotoMessageViewer() [ Language = javascript ]

• method onServerMethodError(err, errObject) [ Language = javascript ]

Intercept xmlHTTP errors and reload page rather than putting up alert box.

• method onlayoutHandler(load) [ Language = javascript ]

This client event is fired when the page is resized.

• method onresizeHandler(load) [ Language = javascript ]

This client event is fired when the page is resized.

• method selectCategory(cat) [ Language = javascript ]

User selected a category for the diagram.

• 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 setSortMode(mode) [ Language = javascript ]

Change the current sort mode for the page.

• method updateDetails(timer) [ Language = javascript ]

Update the details pane.

• method updateFilteredCount(ctr, errCtr) [ Language = javascript ]

• method updateMessages(hostName) [ Language = javascript ]

Update the messages table for the given host item.

• method updateMonitor(timer) [ Language = javascript ]

Update the monitor pane.

Class Reference IRIS for UNIX 2024.1.2
Documentation Search