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


class EnsPortal.Queues extends EnsPortal.Template.standardPage

This is the Queues page of the ZEN Ensemble application.

Property Inventory

Method Inventory


parameter ABORTRESOURCE = %Ens_Queues:WRITE;
parameter EDITRESOURCE = %Ens_Queues:WRITE,%Ens_Jobs:WRITE,%Ens_MessageSuspend:USE;
User needs WRITE permissions on either the %Ens_Queues or the %Ens_Jobs resource or USE permissions on %Ens_MessageSuspend to make changes to this page.
parameter JOBSRESOURCE = %Ens_Jobs:WRITE;
parameter PAGENAME = Queues;
Displayed name of this page.
parameter RESOURCE = %Ens_Queues:READ;
User needs READ permissions on the %Ens_Queues resource to access this page.
parameter SUSPENDRESOURCE = %Ens_MessageSuspend:USE;


property MsgID as %String (ZENURL = "MSGID");
Property methods: MsgIDDisplayToLogical(), MsgIDGet(), MsgIDIsValid(), MsgIDLogicalToDisplay(), MsgIDLogicalToOdbc(), MsgIDNormalize(), MsgIDSet()
property Queue as %String (ZENURL = "QUEUE");
Property methods: QueueDisplayToLogical(), QueueGet(), QueueIsValid(), QueueLogicalToDisplay(), QueueLogicalToOdbc(), QueueNormalize(), QueueSet()
property detailsHidden as %Boolean [ InitialExpression = 1 ];
Property methods: detailsHiddenDisplayToLogical(), detailsHiddenGet(), detailsHiddenIsValid(), detailsHiddenLogicalToDisplay(), detailsHiddenLogicalToXSD(), detailsHiddenNormalize(), detailsHiddenSet(), detailsHiddenXSDToLogical()
property msgViewTrace as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace") ];
Property methods: msgViewTraceDisplayToLogical(), msgViewTraceGet(), msgViewTraceIsValid(), msgViewTraceLogicalToDisplay(), msgViewTraceLogicalToOdbc(), msgViewTraceNormalize(), msgViewTraceSet()
property queueCount as array of %Integer;
Property methods: queueCountBuildValueArray(), queueCountCollectionToDisplay(), queueCountCollectionToOdbc(), queueCountDisplayToCollection(), queueCountDisplayToLogical(), queueCountGet(), queueCountGetObject(), queueCountGetObjectId(), queueCountGetSwizzled(), queueCountIsValid(), queueCountLogicalToDisplay(), queueCountNormalize(), queueCountOdbcToCollection(), queueCountSet(), queueCountSetObject(), queueCountSetObjectId(), queueCountXSDToLogical()
property securityHelper as %ZEN.proxyObject;
Zen proxy object to help determine what actions a user may take on the page.
Property methods: securityHelperGet(), securityHelperGetSwizzled(), securityHelperIsValid(), securityHelperNewObject(), securityHelperSet()
property selectedActiveMessages as %String;
Property methods: selectedActiveMessagesDisplayToLogical(), selectedActiveMessagesGet(), selectedActiveMessagesIsValid(), selectedActiveMessagesLogicalToDisplay(), selectedActiveMessagesLogicalToOdbc(), selectedActiveMessagesNormalize(), selectedActiveMessagesSet()
property selectedMessages as %String;
Property methods: selectedMessagesDisplayToLogical(), selectedMessagesGet(), selectedMessagesIsValid(), selectedMessagesLogicalToDisplay(), selectedMessagesLogicalToOdbc(), selectedMessagesNormalize(), selectedMessagesSet()
property selectedTable as %String;
Property methods: selectedTableDisplayToLogical(), selectedTableGet(), selectedTableIsValid(), selectedTableLogicalToDisplay(), selectedTableLogicalToOdbc(), selectedTableNormalize(), selectedTableSet()


Inherited description: Return the array of links to show in the locator bar.
method %OnAfterCreatePage() as %Status
Show/hide the toggle buttons
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method AbortAllMessages(pQueueName As %String) as %String [ ZenMethod ]
classmethod AbortJobMsg(pJob As %String) as %String [ ZenMethod ]
method AbortMessage(pIndex As %String, pPriority As %Integer, pQueueName As %String) as %String [ ZenMethod ]
method DrawBodyInfo(pHeaderID As %String) as %Status
Write out contents of body details panel. pHeaderID is the message id.
method DrawCountCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
method DrawDetailsContent(pID As %String) as %Status
Write out contents of details panel. pID is the message id.
Write out the links to show the full contents of a message.
classmethod EnumerateActiveMessageClose(ByRef qHandle As %Binary) as %Status
classmethod EnumerateActiveMessageExecute(ByRef qHandle As %Binary, pHostName As %String = "") as %Status
classmethod EnumerateActiveMessageFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod EnumerateQueueContentsClose(ByRef qHandle As %Binary) as %Status
classmethod EnumerateQueueContentsExecute(ByRef qHandle As %Binary, pQueueName As %String, pPriorKey As %String = "") as %Status
classmethod EnumerateQueueContentsFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod EnumerateQueuesClose(ByRef qHandle As %Binary) as %Status
classmethod EnumerateQueuesExecute(ByRef qHandle As %Binary, pFilter As %String = "") as %Status
classmethod EnumerateQueuesFetch(ByRef qHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
classmethod GetHyperEventResources(pMethod As %String = "") as %String
Callback to return a list of resources required for a specific HyperEvent. The user must have sufficient privileges on one of the resource/permission pairs to be permitted to execute the hyperevent. An empty string implies the user already has sufficient privileges for the ZenMethod specified in pMethod.
classmethod GetQueueCount(pQueueName As %String) as %Integer [ ZenMethod ]
Get Queue Count for Business Hosts with Queue Count larger than rowCount
classmethod GetSecurityHelper() as %ZEN.proxyObject [ ZenMethod ]
classmethod MessagePriorityToText(pPriority As %Integer = "") as %String
API to convert the numeric message priority value in pPriority into the corresponding text 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 SuspendJobMsg(pJob As %String) as %String [ ZenMethod ]
clientmethod changeRefreshContents() [ Language = javascript ]
User chose a new Auto-Refresh value for active messages and queue contents tables; set a new timeout value and start the timer
clientmethod changeRefreshQueues() [ Language = javascript ]
User chose a new Auto-Refresh value for queues table; set a new timeout value and start the timer
clientmethod checkHelper(toCheck, noAlert) [ Language = javascript ]
clientmethod doAbort() [ Language = javascript ]
clientmethod doAbortAll() [ Language = javascript ]
clientmethod drawDetails(messageId) [ Language = javascript ]
Update the details for a selected message.
clientmethod filterChanged() [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
clientmethod hideItem() [ Language = javascript ]
hide detailTable
clientmethod jobAbortMsg() [ Language = javascript ]
clientmethod jobSuspendMsg() [ Language = javascript ]
clientmethod layoutMessagesGroup() [ Language = javascript ]
Layout the Message Panel so that the contents table has a scrollbar if necessary, until the page is so small that it makes more sense for the entire panel to have a scroll bar. Then get rid of the scrollbar on the contents table in order to avoid double scrollbars.
clientmethod layoutTabGroup() [ Language = javascript ]
Handle the client-side rendering the of the right hand pane. This is primarily due to IE as it shrinks the contents div without this intervention. The function only adjusts the size of the tab group is not hidden.
clientmethod onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
clientmethod onTraceSVGLoad() [ Language = javascript ]
Callback from the Trace SVG onSVGLoad() callback. The callback is used to ensure that we have the loaded SVG diagram available before we attempt to resize the diagram or highlight the currently selected message.
clientmethod onlayoutHandler(load) [ Language = javascript ]
Adjust sizes of components on the page. The primary purposes of this function are to ensure that the details pane is sized correctly based on whether the tab group is hidden, and to correctly update the expander text and the contents of the tab group.
clientmethod onloadHandler() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
clientmethod refreshAll() [ Language = javascript ]
Reload diagram with a fresh copy.
clientmethod refreshContentsTimeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh active messages and queue contents tables and restart the timer
clientmethod refreshMessages() [ Language = javascript ]
clientmethod refreshQueuesTimeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh queues table and restart the timer
clientmethod reselectActiveMessages() [ Language = javascript ]
reselected messages that were selected prior to the table being refreshed
clientmethod reselectMessages() [ Language = javascript ]
reselected messages that were selected prior to the table being refreshed
clientmethod scaleSVGTrace() [ Language = javascript ]
Correctly resize the SVG trace diagram to fit into the current SVG frame size.
clientmethod selectItem(row, table) [ Language = javascript ]
clear selected row from other message table & show detailTable for a selected task
clientmethod selectQueue(row) [ Language = javascript ]
show contentTable for a selected queue
clientmethod setResultsCount() [ Language = javascript ]
clientmethod showContentTables() [ Language = javascript ]
called from selectQueue and %onAfterCreatePage
clientmethod showFullContent(showRaw) [ Language = javascript ]
Show the full content of the current message in a new window or tab.
clientmethod showItem(msgId) [ Language = javascript ]
Update the details for the selected message
clientmethod showTrace(row) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.
clientmethod updateActiveMessageTable(active) [ Language = javascript ]
clientmethod updateQueuedMessageTable(tbl) [ Language = javascript ]
clientmethod updateQueuesTable() [ Language = javascript ]
clientmethod updateSecurityHelper() [ Language = javascript ]


query EnumerateActiveMessage(pHostName As %String)
Selects Name As %String, Job As %String, Status As %String, AdapterState As %String, LastActivity As %TimeStamp, Count As %Integer, Method As %String, Retry As %Integer, ActiveMessage As %String
Returns job status for a specific host
query EnumerateQueueContents(QueueName As %String, PriorKey As %String = "")
Selects Priority As %String, Index As %Integer, MessageId As %String
PriorKey is a concatenated string that consists of the Priority, "|", and the Index.
query EnumerateQueues(Filter As %String = "")
Selects Name As %String, Count As %Integer, Created As %String, Active As %String
List the known queues and their current counters

Inherited Members

Inherited Properties

Inherited Methods