EnsPortal.MessageResend

class EnsPortal.MessageResend extends EnsPortal.Template.standardPage

This is the page shown to confirm the actions of the Message Resend page of the ZEN application.

Property Inventory

Method Inventory

Parameters

parameter AssistantClass = EnsPortal.MsgFilter.Assistant;
Name of the Assistant class to use for filtered results.
parameter EDITRESOURCE = %Ens_MessageEditResend:USE;
User needs USE permissions on the %Ens_MessageEditResend resource to edit and resend messages.
parameter IDColumn = 1;
Numeric column of the resultset which contains the ID column.
parameter MAXDISPLAYROWS = 500;
Maximum number of rows to display.
parameter MessageClass = Ens.MessageHeader;
Type of header messages.
parameter PAGENAME = Message Resend;
Displayed name of this page.
parameter RESOURCE = %Ens_MessageResend:USE;
User needs USE permissions on the %Ens_MessageResend resource to view this page.
parameter TABLECOLUMNS = 7;
Number of columns drawn in the result table. This is used by some of the helper functions to add messages to the table.

Properties

property HeadOfQueue as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether messages should be resent as the head of the queue.
Property methods: HeadOfQueueDisplayToLogical(), HeadOfQueueGet(), HeadOfQueueIsValid(), HeadOfQueueLogicalToDisplay(), HeadOfQueueLogicalToOdbc(), HeadOfQueueLogicalToXSD(), HeadOfQueueNormalize(), HeadOfQueueSet(), HeadOfQueueXSDToLogical()
property Key as %ZEN.Datatype.string (ZENURL = "KEY");
Index of ^IRIS.Temp.ResendIDs in use for this resend
Property methods: KeyDisplayToLogical(), KeyGet(), KeyIsValid(), KeyLogicalToDisplay(), KeyLogicalToOdbc(), KeyNormalize(), KeySet()
property Messages as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Property methods: MessagesDisplayToLogical(), MessagesGet(), MessagesIsValid(), MessagesLogicalToDisplay(), MessagesLogicalToOdbc(), MessagesLogicalToXSD(), MessagesNormalize(), MessagesSet(), MessagesXSDToLogical()
property NewTarget as %ZEN.Datatype.string;
Property methods: NewTargetDisplayToLogical(), NewTargetGet(), NewTargetIsValid(), NewTargetLogicalToDisplay(), NewTargetLogicalToOdbc(), NewTargetNormalize(), NewTargetSet()
property Number as %ZEN.Datatype.string (ZENURL = "NUM") [ InitialExpression = ..#MAXDISPLAYROWS ];
Number of messages to resend.
Property methods: NumberDisplayToLogical(), NumberGet(), NumberIsValid(), NumberLogicalToDisplay(), NumberLogicalToOdbc(), NumberNormalize(), NumberSet()
property SortOrder as %ZEN.Datatype.string (ZENURL = "SORT");
Order in which to iterate over the messages.
Property methods: SortOrderDisplayToLogical(), SortOrderGet(), SortOrderIsValid(), SortOrderLogicalToDisplay(), SortOrderLogicalToOdbc(), SortOrderNormalize(), SortOrderSet()
property UseFilter as %ZEN.Datatype.string (ZENURL = "FILTER");
Whether to use the current Filter to fetch more results.
Property methods: UseFilterDisplayToLogical(), UseFilterGet(), UseFilterIsValid(), UseFilterLogicalToDisplay(), UseFilterLogicalToOdbc(), UseFilterNormalize(), UseFilterSet()
property canViewContents as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageContent","USE") ];
Flag to indicate whether the user may view message contents.
Property methods: canViewContentsDisplayToLogical(), canViewContentsGet(), canViewContentsIsValid(), canViewContentsLogicalToDisplay(), canViewContentsLogicalToOdbc(), canViewContentsLogicalToXSD(), canViewContentsNormalize(), canViewContentsSet(), canViewContentsXSDToLogical()
property canViewHeaders as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageHeader","USE") ];
Flag to indicate whether the user may view Header data.
Property methods: canViewHeadersDisplayToLogical(), canViewHeadersGet(), canViewHeadersIsValid(), canViewHeadersLogicalToDisplay(), canViewHeadersLogicalToOdbc(), canViewHeadersLogicalToXSD(), canViewHeadersNormalize(), canViewHeadersSet(), canViewHeadersXSDToLogical()
property canViewQueues as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_Queues","READ") ];
Flag to indicate whether the user may view Queue information.
Property methods: canViewQueuesDisplayToLogical(), canViewQueuesGet(), canViewQueuesIsValid(), canViewQueuesLogicalToDisplay(), canViewQueuesLogicalToOdbc(), canViewQueuesLogicalToXSD(), canViewQueuesNormalize(), canViewQueuesSet(), canViewQueuesXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MessageTrace","USE") ];
Flag to indicate whether the user may view Trace messages.
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()
property editResendPage as %ZEN.Datatype.string [ InitialExpression = "EnsPortal.MessageResendEdit.zen" ];
Page for editing and resending messages.
Property methods: editResendPageDisplayToLogical(), editResendPageGet(), editResendPageIsValid(), editResendPageLogicalToDisplay(), editResendPageLogicalToOdbc(), editResendPageNormalize(), editResendPageSet()
property filterClass as %ZEN.Datatype.className [ InitialExpression = "EnsPortal.MsgFilter.Filter" , ReadOnly ];
Name of the Filter class used for filtered results.
Property methods: filterClassDisplayToLogical(), filterClassGet(), filterClassIsValid(), filterClassLogicalToDisplay(), filterClassLogicalToOdbc(), filterClassNormalize()
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" ];
Property methods: viewerPageDisplayToLogical(), viewerPageGet(), viewerPageIsValid(), viewerPageLogicalToDisplay(), viewerPageLogicalToOdbc(), viewerPageNormalize(), viewerPageSet()

Methods

Inherited description: Return the array of links to show in the locator bar.
pLink(n)=$LB(caption,link)
method %OnGetPageName() as %String [ Language = objectscript ]
Get the (localized) name of the page.
method %OnGetTitle() as %String [ Language = objectscript ]
Get the (localized) title string for the page.
method AddMessage(pNewMessage As %String = "", pType As %String = "error", pClearOldMessage As %Boolean = 1, pClass As %String = "") as %String [ Language = objectscript, ZenMethod ]
method CleanUpIDs() [ Language = objectscript, ZenMethod ]
method DrawBodyInfo(pHeaderID As %String) as %Status [ Language = objectscript ]
Write out contents of body details panel. pHeaderID is the message id.
method DrawDetailsContent(pID As %String) as %Status [ Language = objectscript ]
Write out contents of details panel. pID is the message id.
method DrawHTMLFields(tSessionId As %String) as %Status [ Language = objectscript ]
Provide HTML for selected messages.
method OnDrawRibbon() as %Status [ Language = objectscript ]
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 [ Language = objectscript ]
Get information to display in the ribbon bar.
method PrepareResults() as %String [ Language = objectscript, ZenMethod ]
Perform any processing based on the incoming request.
method ReallyResend() as %String [ Language = objectscript, ZenMethod ]
clientmethod cancelPage() [ Language = javascript ]
clientmethod chooseHead() [ Language = javascript ]
Set the HeadOfQueue property of the page based on the value in the "Resubmit at head of queue" checkbox.
clientmethod chooseTarget() [ Language = javascript ]
Set the NewTarget property of the page based on the value in the "New target" drop-down list.
clientmethod editResend() [ Language = javascript ]
clientmethod getEditURL() [ Language = javascript ]
clientmethod launchQueue(name) [ Language = javascript ]
User clicked a link for a Config item. Show the queues page sorted for that queue.
clientmethod onloadHandler() [ Language = javascript ]
Ensure that tab behaviour is initialised correctly.
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 resendMessages() [ Language = javascript ]
Resend the messages and then display the Confirm Resend page.
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

Feedback