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

EnsPortal.MessageResendEdit

class EnsPortal.MessageResendEdit extends EnsPortal.Template.standardPage

This is the Message Resend page of the ZEN Ensemble application. We always do a "resend" from the message viewer page but a "resubmit" from the suspended messages page.

Property Inventory

Method Inventory

Parameters

parameter HEADERCLASS = Ens.MessageHeader;
parameter PAGENAME = Message Edit and Resend;
Displayed name of this page.
parameter RESOURCE = %Ens_MessageEditResend:USE;
User needs USE permissions on the %Ens_MessageEditResend resource to view this page.

Properties

property HeadOfQueue as %ZEN.Datatype.boolean (ZENURL = "HEAD") [ InitialExpression = 0 ];
If supplied and true, this means to put this message at the head of its queue
Property methods: HeadOfQueueDisplayToLogical(), HeadOfQueueGet(), HeadOfQueueIsValid(), HeadOfQueueLogicalToDisplay(), HeadOfQueueLogicalToOdbc(), HeadOfQueueLogicalToXSD(), HeadOfQueueNormalize(), HeadOfQueueSet(), HeadOfQueueXSDToLogical()
The actual message header identifier
Property methods: HeaderDisplayToLogical(), HeaderGet(), HeaderIsValid(), HeaderLogicalToDisplay(), HeaderLogicalToOdbc(), HeaderNormalize(), HeaderSet()
property Key as %ZEN.Datatype.string (ZENURL = "KEY");
Identifies in which global to find the message header identifier
Property methods: KeyDisplayToLogical(), KeyGet(), KeyIsValid(), KeyLogicalToDisplay(), KeyLogicalToOdbc(), KeyNormalize(), KeySet()
property NewTarget as %ZEN.Datatype.string (ZENURL = "TARGET");
If supplied, this is the new target to which to send the message
Property methods: NewTargetDisplayToLogical(), NewTargetGet(), NewTargetIsValid(), NewTargetLogicalToDisplay(), NewTargetLogicalToOdbc(), NewTargetNormalize(), NewTargetSet()
property Send as %ZEN.Datatype.boolean (ZENURL = "SEND") [ InitialExpression = 0 ];
If true, this is the second time through this page and we are definitely resending the message. Otherwise it is the first time through.
Property methods: SendDisplayToLogical(), SendGet(), SendIsValid(), SendLogicalToDisplay(), SendLogicalToOdbc(), SendLogicalToXSD(), SendNormalize(), SendSet(), SendXSDToLogical()
property Suspended as %ZEN.Datatype.boolean (ZENURL = "SUSP") [ InitialExpression = 0 ];
If supplied and true, this tells us that the parent page is the suspended messages page rather than the message viewer page. We always do a "resend" from the message viewer page but a "resubmit" from the suspended messages page. Resend - clone a new header for the message and send with the new header. Resubmit - do not clone a new header for the message, instead resubmit using the old header.
Property methods: SuspendedDisplayToLogical(), SuspendedGet(), SuspendedIsValid(), SuspendedLogicalToDisplay(), SuspendedLogicalToOdbc(), SuspendedLogicalToXSD(), SuspendedNormalize(), SuspendedSet(), SuspendedXSDToLogical()
property canViewContents as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageContent","USE") ];
Property methods: canViewContentsDisplayToLogical(), canViewContentsGet(), canViewContentsIsValid(), canViewContentsLogicalToDisplay(), canViewContentsLogicalToOdbc(), canViewContentsLogicalToXSD(), canViewContentsNormalize(), canViewContentsSet(), canViewContentsXSDToLogical()
property canViewHeaders as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageHeader","USE") ];
Property methods: canViewHeadersDisplayToLogical(), canViewHeadersGet(), canViewHeadersIsValid(), canViewHeadersLogicalToDisplay(), canViewHeadersLogicalToOdbc(), canViewHeadersLogicalToXSD(), canViewHeadersNormalize(), canViewHeadersSet(), canViewHeadersXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()
property messageDisplayPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.Dialog.MessageBodyDisplay.zen" ];
Page to use for displaying message content.
Property methods: messageDisplayPageDisplayToLogical(), messageDisplayPageGet(), messageDisplayPageIsValid(), messageDisplayPageLogicalToDisplay(), messageDisplayPageLogicalToOdbc(), messageDisplayPageNormalize(), messageDisplayPageSet()
property messageTracePage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.VisualTrace.zen" ];
Page for displaying the visual trace.
Property methods: messageTracePageDisplayToLogical(), messageTracePageGet(), messageTracePageIsValid(), messageTracePageLogicalToDisplay(), messageTracePageLogicalToOdbc(), messageTracePageNormalize(), messageTracePageSet()
property resendResultPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageResendAfter.zen" ];
Page to use for displaying the results of the resend.
Property methods: resendResultPageDisplayToLogical(), resendResultPageGet(), resendResultPageIsValid(), resendResultPageLogicalToDisplay(), resendResultPageLogicalToOdbc(), resendResultPageNormalize(), resendResultPageSet()
property viewerPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageViewer.zen" ];
Page for displaying messages.
Property methods: viewerPageDisplayToLogical(), viewerPageGet(), viewerPageIsValid(), viewerPageLogicalToDisplay(), viewerPageLogicalToOdbc(), viewerPageNormalize(), viewerPageSet()

Methods

method %OnGetPageName() as %String
Get the (localized) name of the page.
method %OnGetTitle() as %String
Get the (localized) title string for the page.
method CleanUpIDs() as %String [ ZenMethod ]
Get rid of the global that has been storing the information about our chosen messages. This happens only if we are truly done with this page.
method DrawHTMLFields(tSessionId As %String) as %Status
Provide HTML for editing the selected message. Most code extracted from old CSP page.
method GetSubmitURL() as %String
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 PerformResend(pHeader As Ens.MessageHeaderBase, pNewBody As %RegisteredObject, Output pNewHeaderId As %String, Output pText) as %Status
clientmethod onunloadHandler() [ Language = javascript ]
Inherited description: This client event, if present, is fired when the page is unloaded. If this method returns a string value, then that is used as the return value of the HTML page's onbeforeunload handler (if more than one component returns a string, the first one encountered is used).
clientmethod saveEdit() [ Language = javascript ]
Modified from the earlier CSP version of this page, which was IE-specific. This method is invoked when the user clicks OK on the automatically generated HTML form from DrawHTMLFields(). It references fields on the form and submits the form. Then it displays the URL provided when the form was created in DrawHTMLFields().
clientmethod showBody(messageId) [ Language = javascript ]
Update the details for a selected message.
clientmethod showHeader(messageId) [ Language = javascript ]
Update the details for a selected message.
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 display.

Inherited Members

Inherited Properties

Inherited Methods

Subclasses

FeedbackOpens in a new window