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?


class EnsPortal.MessageViewer extends EnsPortal.Template.filteredViewer

Message viewer page for Ensemble portal.

Property Inventory

Method Inventory


parameter CANCANCELSEARCH = 1;
Indicate if can cancel search. This defines whether tempPortalNode is set.
parameter PAGENAME = Message Viewer;
Name of this page.
parameter RESOURCE = %Ens_MessageHeader:USE;
User needs USE permissions on the %Ens_MessageHeader resource to view this page.
Indicate if ought to create tempPortalNode when page created. Used by Cancel feature for example.
parameter VALUECOLUMN = ID;
Name of column in query that supplies ID values.


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 canViewContents as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view body contents.
Property methods: canViewContentsDisplayToLogical(), canViewContentsGet(), canViewContentsIsValid(), canViewContentsLogicalToDisplay(), canViewContentsLogicalToOdbc(), canViewContentsLogicalToXSD(), canViewContentsNormalize(), canViewContentsSet(), canViewContentsXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean;
Flag to indicate whether the user is permitted to view the message trace tab.
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()
property matchSourceOrTarget as %ZEN.Datatype.string (ZENURL = "SOURCEORTARGET");
Property methods: matchSourceOrTargetDisplayToLogical(), matchSourceOrTargetGet(), matchSourceOrTargetIsValid(), matchSourceOrTargetLogicalToDisplay(), matchSourceOrTargetLogicalToOdbc(), matchSourceOrTargetNormalize(), matchSourceOrTargetSet()
property msgViewTraceHover as %ZEN.Datatype.caption [ InitialExpression = $$$Text("View Full Trace including Events, ACKs, IO entries and message contents") ];
Property methods: msgViewTraceHoverDisplayToLogical(), msgViewTraceHoverGet(), msgViewTraceHoverIsValid(), msgViewTraceHoverLogicalToDisplay(), msgViewTraceHoverLogicalToOdbc(), msgViewTraceHoverNormalize(), msgViewTraceHoverSet()


method %OnAfterCreatePage() as %Status
Show/hide the toggle buttons
method %OnGetDetailsLinkMenu(Output pMenu2)
Get the contents of the Details' link menu.
method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTableLinkMenu(Output pMenu)
Get the contents of the link menu in the table.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method DrawStatusCell(table As %ZEN.Component.tablePane, name As %ZEN.Datatype.string, seed As %ZEN.Datatype.string) as %Status
Server-side method to write out localized content for the Status column
classmethod GetContentMessages(messages As %ZEN.proxyObject) as %ZEN.proxyObject [ ZenMethod ]
Get localized messages for the message contents pane.
method OnGetRibbonInfo(Output pDisplay As %Library.Boolean, Output pViewIcons As %Library.List, Output pSortOptions As %Library.List, Output pSearchBox As %Library.Boolean, Output pRibbonTitle As %Library.String, Output pCommands As %Library.List) as %Status
Get information to display in the ribbon bar.
method SetSearchCriteria() as %String [ ZenMethod ]
clientmethod onChangeResultsPage(next, pageSize, currentPage) [ Language = javascript ]
Callback to set up the resultset/query for paging
clientmethod onlayoutHandler(load) [ Language = javascript ]
Ensure we don't call onlayoutHandler() reentrantly under older versions of IE8
clientmethod sequenceSearch(searchType) [ Language = javascript ]
Helper method to trigger Sequence Manager searches.
clientmethod showTrace(sessionId, evt) [ Language = javascript ]
User clicked a link for Trace. Display the Visual Trace page.

Inherited Members

Inherited Properties

Inherited Methods