Class Ens.Enterprise.Portal.MonitorStatus

class Ens.Enterprise.Portal.MonitorStatus extends EnsPortal.Template.viewerPage, Ens.Enterprise.Portal.base

Created using the page template: Default

Parameters	Properties	Methods	Queries	Indices	ForeignKeys	Triggers
3	18	46

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
aux	backgroundTimerInterval	canEdit	canViewEvents
canViewMessages	canViewMonitorRoles	canViewSearch	canViewSystems
canViewTrace	cellAlign	cellSize	cellStyle
cellVAlign	children	composite	contactPage
containerStyle	cssLevel	currSortMode	currStep
currViewMode	currentPage	currentPageStart	detailsHidden
detailsWidth	disabled	dragAndDrop	dragEnabled
dropEnabled	enableAutoRefresh	enclosingClass	enclosingStyle
endId	error	groupClass	groupStyle
height	hidden	hideDetailsMsg	hideSearchMsg
hint	hintClass	hintStyle	home
homePage	id	index	isFirstPage
isLastPage	keepAliveInterval	label	labelClass
labelDisabledClass	labelPosition	labelStyle	layout
lblDetails	lblTitle	limitPopups	matchSource
msgCloseDetail	msgNotPermitted	name	onafterdrag
onbeforedrag	onclick	ondrag	ondrop
onhide	onrefresh	onshow	onupdate
pageId	pageModified	pageNumberId	pageSizeId
parent	queryAtEnd	resultsTableId	roleCategories
searchCriteria	searchJob	searchKey	searchQuery
selectedId	sessionLinkTitle	showDetailsMsg	showLabel
showSearchMsg	slice	startId	tablePaneUsesSQLAttrib
tempPortalNode	title	tracePage	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	CheckAllBlanks	CheckContextLinks
CheckEnterpriseManager	ConvertParameter	Decrypt
DoLogout	DrawDetailsContent	DrawLocator
DrawRibbon	DrawTitle	Encrypt
EscapeHTML	EscapeURL	EvalResult
GetCSPURL	GetColumnsAndFrom	GetContextLinks
GetDocURL	GetHomePage	GetHyperEventResources
GetLocator	GetNewURL	GetQuickLinks
GetRemoteSearchJob	HyperEventCall	HyperEventHead
Include	InsertHiddenField	InsertHiddenFields
IsPrivate	JavaInstalled	Link
OnDrawRibbon	OnGetRibbonInfo	OnHTTPHeader
OnPage	OnPageError	OnPostHTTP
OnPostHyperEvent	OnPreHTTP	OnPreHyperEvent
Page	PrepareCancel	QuoteJS
RegisterRecent	RemoveTempData	ResetQuery
RewriteURL	ShowError	SignalCancel
SimpleKeepAlive	StartTimer	StopTimer
ThrowError	UnescapeHTML	UnescapeURL
UpdateAutoRefreshRate	XMLDTD	XMLExport
XMLExportToStream	XMLExportToString	XMLNew
XMLSchema	XMLSchemaNamespace	XMLSchemaType
addChild	addChildAfter	addChildBefore
addPopupSuffix	adjustExpanderText	adjustTableHeight
arrowClick	cancelPopup	cancelSearch
changePassword	changeRefresh	changeURLNamespace
checkEdit	childrenMutated	clientKeepAlive
correctIELayering	createComponent	createComponentNS
createTimeWarning	deleteComponent	disableCommandButton
displayCountDown	displayRefreshTimestamp	displayUpdateReasonLabel
doCustomCell	doRefresh	doSearch
dragFinishHandler	dragHandler	dragNotifyHandler
dragStartHandler	drawBarGraph	drawNewClientButton
drawQueueCount	dropHandler	dropStartHandler
enableCommandButton	endModal	executeSearch
exposeComponent	findElement	fireOnResizeEvent
fireOnUnloadEvent	fireOnUpdateEvent	firePopupAction
getChildIndex	getComponent	getComponentById
getContentAreaHeight	getEnclosingDiv	getFramePosition
getHidden	getHintElement	getLabelElement
getNextData	getOpener	getPageTitle
getProperty	getResultsTable	getSearchForm
getSettings	getTitleAreaHeight	getType
goHome	goMenu	gotoEnterpriseMonitorRoles
gotoEnterpriseMsgViewer	gotoEnterpriseSystems	gotoEnterpriseSystemsNewConnection
gotoMsgBankEvtLog	gotoMsgBankViewer	gotoNamespace
gotoPage	hideCommandButton	hideDetailsTable
hideTimeoutWarning	hideWarnContinue	inResizeLoop
indicateIfCancelled	initPopupSuffix	invokeSuper
isEnterpriseProductionRunning	isOfType	launchPopupWindow
logout	makeEnsPortalLink	makeId
makeSysPortalLink	manualKeepAlive	maybeDisplayUpdateReasonLabel
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
refreshData	removeChild	removePopupSuffix
render	renderContents	renderSVG
searchBlur	searchBoxHandler	searchFocus
searchKeyDown	searchKeyPress	selectItem
setColor	setComponentId	setConnectivityStatusMsg
setHidden	setIframeSize	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
updateNavigationButtons	updatePageData	updatePageNumber
updatePageSize	warnclickListener

Parameters

• parameter PAGENAME = "Enterprise Monitor";

Displayed name of this page.

• parameter RESOURCE = "%Ens_MsgBank_Dashboard:USE";

User needs USE permissions on the %Ens_MsgBank_Dashboard resource to view this page.

• parameter SHOWSEARCHTOGGLE = 0;

Indicate whether toggle button for search pane should be displayed.

Properties

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

• property canViewMessages as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(Ens.Enterprise.Portal.MsgBankViewer).#RESOURCE) ];

• property canViewMonitorRoles as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(Ens.Enterprise.Portal.MonitorRoleList).#RESOURCE) ];

• property canViewSearch as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(Ens.Enterprise.Portal.EnterpriseSearch).#RESOURCE) ];

• property canViewSystems as %Boolean [ InitialExpression = ##class(EnsPortal.Utils).CheckResourceList(##class(Ens.Enterprise.Portal.SystemList).#RESOURCE) ];

• property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];

• property detailsHidden as %ZEN.Datatype.boolean [ InitialExpression = 1 ];

Flag to indicate whether the detailsPanel is currently hidden.

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

Value to indicate the percentage of the horizontal screen which should be devoted to the details panel (if it is visible). This is exposed as a client-side property for the layout code to use the value.

• property endId as %ZEN.Datatype.string(ZENURL="EndId");

• property matchSource as %ZEN.Datatype.string(ZENURL="SOURCE");

• property pageNumberId as %ZEN.Datatype.id [ InitialExpression = "pageTotal" ];

Id of the page number field

• property pageSizeId as %ZEN.Datatype.id [ InitialExpression = "MaxRows" ];

Id of the page size field

• property resultsTableId as %ZEN.Datatype.id [ InitialExpression = "table" ];

Id of the results tablePane

• property roleCategories as %ZEN.Datatype.string;

• property sessionLinkTitle as %ZEN.Datatype.caption [ InitialExpression = $$$Text("Click to view a visual trace of the session") ];

• property startId as %ZEN.Datatype.string(ZENURL="StartId");

• property tracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];

Methods

• method %OnAfterCreatePage() as %Status

Show/hide the toggle buttons

• 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 GetLocator(pTitlePane As %CSP.Util.TitlePane, ByRef pAddress As %String, ByRef pBaseURL As %String = "") as %String

• method OnDrawRibbon() as %Status

Add to the contents of the tool ribbon.

• method OnGetRibbonInfo(Output pDisplay As %Boolean, Output pViewIcons As %List, Output pSortOptions As %List, Output pSearchBox As %Boolean, Output pRibbonTitle As %String, Output pCommands As %List) as %Status

Get information to display in the ribbon bar.

• classmethod UpdateAutoRefreshRate(refreshrate As %Integer) [ ZenMethod ]

Save auto refresh rate (how many seconds user entered) to server.

• method adjustTableHeight() [ Language = javascript ]

Adjust table height to account for status section

• method changeRefresh() [ Language = javascript ]

User chose a new Auto-Refresh value for the table; set a new timeout value and start the timer

• method changeURLNamespace(value) as %String [ Language = javascript ]

The input value is the name of the new namespace to switch to. This method will need to be overridden for classes such as EnsPortal.EDIDocumentView which cannot work without a URL parameter provided.

• method displayRefreshTimestamp() [ Language = javascript ]

redisplay the last time that the entire cycle of system status matrices was updated.

• method displayUpdateReasonLabel(updateReason) [ Language = javascript ]

display the update reason, if it is blank then set the content of the label to null, if it is present, then prepend label text to it TODO: i18n the label text

• method doCustomCell(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

User override of cell-display for a the main table- for the details table. this constructs the link for showing the details table, and it is *only* shown if there are details to show- which is determined by if there is an entry in the "details" column for the query, which should equal the name of the connection for which the details are getting fetched

• method doRefresh() [ Language = javascript ]

Reload diagram with a fresh copy.

• method drawBarGraph(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

User override of cell-display for tablePane. pTable: handle to the tablePane component pName: name of the column for this class query pSeed: Seed value for this table Draw a split bar graph showing the proportion of states of hosts in the production

• method drawNewClientButton(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

Draw "+" button to add new enterprise connections

• method drawQueueCount(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

Draw count of queued messages, highlighting near- and over-threshold value with color

• method getFramePosition(frame, positionArr) [ Language = javascript ]

• method gotoEnterpriseMonitorRoles() [ Language = javascript ]

• method gotoEnterpriseMsgViewer() [ Language = javascript ]

• method gotoEnterpriseSystems() [ Language = javascript ]

• method gotoEnterpriseSystemsNewConnection() [ Language = javascript ]

• method gotoMsgBankEvtLog() [ Language = javascript ]

• method gotoMsgBankViewer() [ Language = javascript ]

• method hideDetailsTable() [ Language = javascript ]

hide the details table, and zero out the detail table name

• method isEnterpriseProductionRunning(Output pProductionName As %String) as %Boolean

• method makeEnsPortalLink(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

• method makeSysPortalLink(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

User override of cell-display for tablePane. pName: name of the column- corresponding to the class query adds a link to the instance name, to the server's management portal

• method maybeDisplayUpdateReasonLabel() [ Language = javascript ]

this method checks if a details table is up- (is there a details table name?) and if so, then uses that name to get the update reason string, and then displays it. called by the refresh timer

• method onToggleDetails() [ Language = javascript ]

If user hides details pane, unselect the current row

• method onlayoutHandler(load) [ Language = javascript ]

This client event is fired when the page is resized.

• method onloadHandler() [ Language = javascript ]

Fired when the page is loaded. refresh the timestamp, the only part of of a new page reload that isn't query based (so isn't automatic) no need to check the update reason, as no detail tables are shown on a fresh reload

• method refreshData(timer) [ Language = javascript ]

called each time the timer goes off, ensures that the data in the tables is current because the queries are re-run and the page is not actually reloaded, the page does not flicker, and onloadHandler() is not run.

• method selectItem(SystemName, updateReason) [ Language = javascript ]

show the details table (the submatrices) for the connection indicated by the SystemName, and the update reason (if there is one), displays on top of the details table. also, the connection name is stored in the session, for the update reason to be "dynamic"- for it to automatically appear and disappear (without the user having to click the "details" link) when the update reason is present and then not present anymore

• method setColor(pTable As %ZEN.Component.tablePane, pName As %String, pSeed As %String) as %Status

User override of cell-display for tablePane. pName: name of the column- corresponding to the class query this method makes the cell have no content, as the color cell should be blank and just contain the background color that is assigned to it in a conditional statement, which is based upon which color (red, yellow, green, purple, orange) that is the original content of the color cell

• method setIframeSize() [ Language = javascript ]

Class Reference IRIS for UNIX 2024.1.2
Documentation Search