Home > Class Reference > ENSLIB namespace > EnsPortal.Queues
Private  Storage   

EnsPortal.Queues


class EnsPortal.Queues extends EnsPortal.Template.standardPage

This is the Queues page of the ZEN Ensemble application.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
6 9 61 3


Summary


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

Properties
%condition %import %includeFiles %page
%resource HelpAddress ISREADONLY LocatorHeader
MsgID ParentURL Queue StdTitle
aboutPage align aux backgroundTimerInterval
canEdit cellAlign cellSize cellStyle
cellVAlign children composite containerStyle
cssLevel currSortMode currStep currViewMode
detailsHidden disabled dragAndDrop dragEnabled
dropEnabled enclosingClass enclosingStyle error
groupClass groupStyle height hidden
hint hintClass hintStyle home
homePage id index keepAliveInterval
label labelClass labelDisabledClass labelPosition
labelStyle layout lblTitle limitPopups
msgNotPermitted msgViewTrace name onafterdrag
onbeforedrag onclick ondrag ondrop
onhide onrefresh onshow onupdate
pageModified parent queueCount searchKey
securityHelper selectedActiveMessages selectedMessages selectedTable
showLabel slice 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
%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
%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 AbortAllMessages AbortJobMsg
AbortMessage BuildMenu CheckAllBlanks CheckContextLinks
CheckEnterpriseManager ConvertParameter Decrypt DoLogout
DrawBodyInfo DrawCountCell DrawDetailsContent DrawFullContentLinks
DrawLocator DrawRibbon DrawTitle Encrypt
EnumerateActiveMessageClose EnumerateActiveMessageExecute EnumerateActiveMessageFetch EnumerateQueueContentsClose
EnumerateQueueContentsExecute EnumerateQueueContentsFetch EnumerateQueuesClose EnumerateQueuesExecute
EnumerateQueuesFetch EscapeHTML EscapeURL EvalResult
GetCSPURL GetContextLinks GetDocPage GetHomePage
GetHyperEventResources GetNewURL GetQueueCount GetQuickLinks
GetSecurityHelper HyperEventCall HyperEventHead Include
InsertHiddenField InsertHiddenFields IsPrivate Link
MessagePriorityToText OnDrawRibbon OnGetRibbonInfo OnHTTPHeader
OnPage OnPageError OnPostHTTP OnPostHyperEvent
OnPreHTTP OnPreHyperEvent Page QuoteJS
RegisterRecent RewriteURL ShowError SimpleKeepAlive
StartTimer StopTimer SuspendJobMsg ThrowError
UnescapeHTML UnescapeURL XMLDTD XMLExport
XMLExportToStream XMLExportToString XMLNew XMLSchema
XMLSchemaNamespace XMLSchemaType addChild addChildAfter
addChildBefore addPopupSuffix arrowClick cancelPopup
changePassword changeRefreshContents changeRefreshQueues changeURLNamespace
checkEdit checkHelper childrenMutated clientKeepAlive
correctIELayering createComponent createComponentNS deleteComponent
disableCommandButton doAbort doAbortAll dragFinishHandler
dragHandler dragNotifyHandler dragStartHandler drawDetails
dropHandler dropStartHandler enableCommandButton endModal
exposeComponent filterChanged findElement fireOnResizeEvent
fireOnUnloadEvent fireOnUpdateEvent firePopupAction getChildIndex
getComponent getComponentById getEnclosingDiv getHidden
getHintElement getLabelElement getOpener getProperty
getSettings getTitleAreaHeight getType goHome
goMenu gotoNamespace gotoPage hideCommandButton
hideItem inResizeLoop initPopupSuffix invokeSuper
isOfType jobAbortMsg jobSuspendMsg launchPopupWindow
layoutMessagesGroup layoutTabGroup logout makeId
navigate onCreate onDelete onDisplayHandler
onEndModalHandler onPopupAction onRefreshContents onSerialize
onServerMethodCall onServerMethodError onServerMethodReturn onStartModalHandler
onTabChange onTraceSVGLoad ondisabledHandler onkeydownHandler
onkeyupHandler onlayoutHandler onloadHandler onlogoutHandler
onoverlayHandler onresizeHandler onunloadHandler onupdateHandler
popupActionHandler refreshAll refreshContents refreshContentsTimeout
refreshMessages refreshQueuesTimeout removeChild removePopupSuffix
render renderContents renderSVG reselectActiveMessages
reselectMessages scaleSVGTrace searchBlur searchBoxHandler
searchFocus searchKeyDown searchKeyPress selectItem
selectQueue setComponentId setConnectivityStatusMsg setHidden
setModified setOverlayMode setProperty setPropertyAll
setResultsCount setSortMode setSortModeHandler setTraceOption
setViewMode setViewModeHandler showAbout showCommandButton
showContentTables showDocumentation showFullContent showHelp
showItem showTrace startKeepAlive startModal
startProgressBar stopKeepAlive stopProgressBar switchNamespace
updateActiveMessageTable updateQueuedMessageTable updateQueuesTable updateSecurityHelper


Parameters


• 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";

Properties


• property MsgID as %String(ZENURL="MSGID");
• property Queue as %String(ZENURL="QUEUE");
• property detailsHidden as %Boolean [ InitialExpression = 1 ];
• property msgViewTrace as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace") ];
• property queueCount as array of %Integer;
• property securityHelper as %ZEN.proxyObject;
Zen proxy object to help determine what actions a user may take on the page.
• property selectedActiveMessages as %String;
• property selectedMessages as %String;
• property selectedTable as %String;

Methods


• method %GetLocatorLinks(Output pLink) as %Status
Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
• 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.
• classmethod DrawFullContentLinks(pSeed As %String) as %Status
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 ]
• method 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
• method changeRefreshQueues() [ Language = javascript ]
User chose a new Auto-Refresh value for queues table; set a new timeout value and start the timer
• method checkHelper(toCheck, noAlert) [ Language = javascript ]
• method doAbort() [ Language = javascript ]
• method doAbortAll() [ Language = javascript ]
• method drawDetails(messageId) [ Language = javascript ]
Update the details for a selected message.
• method filterChanged() [ Language = javascript ]
User entered something in to the filter. Re-load the table with filter value.
• method hideItem() [ Language = javascript ]
hide detailTable
• method jobAbortMsg() [ Language = javascript ]
• method jobSuspendMsg() [ Language = javascript ]
• method 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.
• method 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.
• method onTabChange() [ Language = javascript ]
User clicked on a tab, or selected a new item, so we need to fetch the required content from the server.
• method 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.
• method 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.
• method onloadHandler() [ Language = javascript ]
This callback, if defined, is called when the dialog page is loaded.
• method refreshAll() [ Language = javascript ]
Reload diagram with a fresh copy.
• method refreshContentsTimeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh active messages and queue contents tables and restart the timer
• method refreshMessages() [ Language = javascript ]
• method refreshQueuesTimeout(timer) [ Language = javascript ]
If auto-refresh is still on, refresh queues table and restart the timer
• method reselectActiveMessages() [ Language = javascript ]
reselected messages that were selected prior to the table being refreshed
• method reselectMessages() [ Language = javascript ]
reselected messages that were selected prior to the table being refreshed
• method scaleSVGTrace() [ Language = javascript ]
Correctly resize the SVG trace diagram to fit into the current SVG frame size.
• method selectItem(row, table) [ Language = javascript ]
clear selected row from other message table & show detailTable for a selected task
• method selectQueue(row) [ Language = javascript ]
show contentTable for a selected queue
• method setResultsCount() [ Language = javascript ]
• method showContentTables() [ Language = javascript ]
called from selectQueue and %onAfterCreatePage
• method showFullContent(showRaw) [ Language = javascript ]
Show the full content of the current message in a new window or tab.
• method showItem(msgId) [ Language = javascript ]
Update the details for the selected message
• method showTrace(row) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.
• method updateActiveMessageTable(active) [ Language = javascript ]
• method updateQueuedMessageTable(tbl) [ Language = javascript ]
• method updateQueuesTable() [ Language = javascript ]
• method updateSecurityHelper() [ Language = javascript ]

Queries


• 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