This is documentation for Caché & Ensemble. See the InterSystems IRIS version of this content.

For information on migrating to InterSystems IRIS, see Why Migrate to InterSystems IRIS?

EnsPortal.SuspendedMsg

class EnsPortal.SuspendedMsg extends EnsPortal.Template.listPage

This is the Suspended Messages page of the ZEN Ensemble application.

Property Inventory

Method Inventory

Parameters

parameter PAGENAME = Suspended Messages;
Displayed name of this page.
parameter RESOURCE = %Ens_MessageHeader:USE;
User needs USE permissions on the %Ens_MessageHeader resource to view this page.

Properties

property canDiscard as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageDiscard","USE") ];
Flag to indicate whether a user may discard or delete messages.
Property methods: canDiscardDisplayToLogical(), canDiscardGet(), canDiscardIsValid(), canDiscardLogicalToDisplay(), canDiscardLogicalToOdbc(), canDiscardLogicalToXSD(), canDiscardNormalize(), canDiscardSet(), canDiscardXSDToLogical()
property canEditResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageEditResend","USE") ];
Flag to indicate whether a user may edit and resend messages.
Property methods: canEditResendDisplayToLogical(), canEditResendGet(), canEditResendIsValid(), canEditResendLogicalToDisplay(), canEditResendLogicalToOdbc(), canEditResendLogicalToXSD(), canEditResendNormalize(), canEditResendSet(), canEditResendXSDToLogical()
property canResend as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageResend","USE") ];
Flag to indicate whether a user may resend messages.
Property methods: canResendDisplayToLogical(), canResendGet(), canResendIsValid(), canResendLogicalToDisplay(), canResendLogicalToOdbc(), canResendLogicalToXSD(), canResendNormalize(), canResendSet(), canResendXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Flag to indicate whether a user may access the Visual Trace pages.
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()

Methods

method %OnGetPageName() as %String
Get the (localized) name of the page.
method DeleteMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
method DiscardMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
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.
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.
method ResubmitMessage(pHeaderId As %String) as %String [ ZenMethod ]
Adapted from the old CSP page
clientmethod doDelete() [ Language = javascript ]
User selected a new row in the table
clientmethod doDiscard() [ Language = javascript ]
User selected a new row in the table
clientmethod doEdit() [ Language = javascript ]
User selected a new row in the table
clientmethod doResubmit() [ Language = javascript ]
User selected a new row in the table
clientmethod onlayoutHandler(load) [ Language = javascript ]
The layout for this page is different from that for other list pages because of the iframe
clientmethod showItem(msgId) [ Language = javascript ]
show detailTable for a selected task
clientmethod showTrace(session) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page in a popup, so user can click the arrows to go from session to session without losing his/her place in the Event Log.

Queries

query Enumerate(Filter As %String = "", QueryMethod As %String, QueryClass As %String)
Selects ID, TimeCreated, SessionId, Error, Source
Class query with filter added. Override this in order to add rowspec specific to the list being displayed
query InitQuery()
SQL Query:
SELECT TOP 2000 ID,TimeCreated,SessionId, CASE IsError WHEN 1 THEN 'Yes' ELSE 'No' END As Error,SourceConfigName As Source FROM Ens.MessageHeader WHERE Status = 'Suspended'

Inherited Members

Inherited Properties

Inherited Methods

Feedback