InterSystems IRIS Data Platform 2020.4 > Class Reference > ENSLIB namespace > Ens.Enterprise.Portal.MessageResend

Ens.Enterprise.Portal.MessageResend

class Ens.Enterprise.Portal.MessageResend extends EnsPortal.MessageResend, Ens.Enterprise.Portal.base

Property Inventory

Method Inventory

Parameters

parameter AssistantClass = Ens.Enterprise.Portal.MsgFilter.Assistant;
Name of the Assistant class to use for filtered results.
parameter EDITRESOURCE = %Ens_MsgBank_MessageEditResend:USE;
User needs USE permissions on the %Ens_MsgBank_MessageEditResend resource to edit and resend messages.
parameter IDColumn = 2;
Numeric column of the resultset which contains the ID column.
parameter MessageClass = Ens.Enterprise.MsgBank.MessageHeader;
Type of header messages.
parameter PAGENAME = Message Bank Resend;
Displayed name of this page.
parameter RESOURCE = %Ens_MsgBank_MessageResend:USE;
User needs USE permissions on the %Ens_MsgBank_MessageResend resource to view this page.
parameter TABLECOLUMNS = 9;
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 %Targets as %String [ MultiDimensional ];
Multidimensional array used to cache known targets while drawing the contents of the table.
Property methods: %TargetsDisplayToLogical(), %TargetsGet(), %TargetsIsValid(), %TargetsLogicalToDisplay(), %TargetsLogicalToOdbc(), %TargetsNormalize(), %TargetsSet()
property canViewContents as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MsgBank_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_MsgBank_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 = 0 ];
Flag to indicate whether the user may view Queue information. There are no queues in the Message Bank archive.
Property methods: canViewQueuesDisplayToLogical(), canViewQueuesGet(), canViewQueuesIsValid(), canViewQueuesLogicalToDisplay(), canViewQueuesLogicalToOdbc(), canViewQueuesLogicalToXSD(), canViewQueuesNormalize(), canViewQueuesSet(), canViewQueuesXSDToLogical()
property canViewTrace as %ZEN.Datatype.boolean [ InitialExpression = $system.Security.Check("%Ens_MsgBank_MessageTrace","USE") ];
Flag to indicate whether the user may view Trace messages.
Property methods: canViewTraceDisplayToLogical(), canViewTraceGet(), canViewTraceIsValid(), canViewTraceLogicalToDisplay(), canViewTraceLogicalToOdbc(), canViewTraceLogicalToXSD(), canViewTraceNormalize(), canViewTraceSet(), canViewTraceXSDToLogical()
property clients as array of %ZEN.proxyObject;
All available Clients listed by client name.
Property methods: clientsBuildValueArray(), clientsCollectionToDisplay(), clientsCollectionToOdbc(), clientsDisplayToCollection(), clientsGet(), clientsGetObject(), clientsGetObjectId(), clientsGetSwizzled(), clientsIsValid(), clientsOdbcToCollection(), clientsSet(), clientsSetObject(), clientsSetObjectId()
property doCollective as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether Collective Targeting is in use.
Property methods: doCollectiveDisplayToLogical(), doCollectiveGet(), doCollectiveIsValid(), doCollectiveLogicalToDisplay(), doCollectiveLogicalToOdbc(), doCollectiveLogicalToXSD(), doCollectiveNormalize(), doCollectiveSet(), doCollectiveXSDToLogical()
property doIndividual as %ZEN.Datatype.boolean [ InitialExpression = 0 ];
Flag to indicate whether Individual Targeting is in use.
Property methods: doIndividualDisplayToLogical(), doIndividualGet(), doIndividualIsValid(), doIndividualLogicalToDisplay(), doIndividualLogicalToOdbc(), doIndividualLogicalToXSD(), doIndividualNormalize(), doIndividualSet(), doIndividualXSDToLogical()
property editResendPage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.MessageResendEdit.zen" ];
Page for editing and resending messages.
Property methods: editResendPageDisplayToLogical(), editResendPageGet(), editResendPageIsValid(), editResendPageLogicalToDisplay(), editResendPageLogicalToOdbc(), editResendPageNormalize(), editResendPageSet()
property filterClass as %ZEN.Datatype.className [ InitialExpression = "Ens.Enterprise.Portal.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 = "Ens.Enterprise.Portal.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 = "Ens.Enterprise.Portal.VisualTrace.zen" ];
Page for displaying the visual trace.
Property methods: messageTracePageDisplayToLogical(), messageTracePageGet(), messageTracePageIsValid(), messageTracePageLogicalToDisplay(), messageTracePageLogicalToOdbc(), messageTracePageNormalize(), messageTracePageSet()
property newTargetConfig as %ZEN.Datatype.string;
Name of the new config item to resend messages to. NewTarget is overriden to refer to the target client.
Property methods: newTargetConfigDisplayToLogical(), newTargetConfigGet(), newTargetConfigIsValid(), newTargetConfigLogicalToDisplay(), newTargetConfigLogicalToOdbc(), newTargetConfigNormalize(), newTargetConfigSet()
property nodeIndex as array of %String;
Index of node ID to client name.
Property methods: nodeIndexBuildValueArray(), nodeIndexCollectionToDisplay(), nodeIndexCollectionToOdbc(), nodeIndexDisplayToCollection(), nodeIndexDisplayToLogical(), nodeIndexGet(), nodeIndexGetObject(), nodeIndexGetObjectId(), nodeIndexGetSwizzled(), nodeIndexIsValid(), nodeIndexLogicalToDisplay(), nodeIndexLogicalToOdbc(), nodeIndexNormalize(), nodeIndexOdbcToCollection(), nodeIndexSet(), nodeIndexSetObject(), nodeIndexSetObjectId()
property resendResultPage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.MessageResendAfter.zen" ];
Page to use for displaying the results of the resend.
Property methods: resendResultPageDisplayToLogical(), resendResultPageGet(), resendResultPageIsValid(), resendResultPageLogicalToDisplay(), resendResultPageLogicalToOdbc(), resendResultPageNormalize(), resendResultPageSet()
property targetingClass as %ZEN.Datatype.className;
Name of the Targeting class to use.
Property methods: targetingClassDisplayToLogical(), targetingClassGet(), targetingClassIsValid(), targetingClassLogicalToDisplay(), targetingClassLogicalToOdbc(), targetingClassNormalize(), targetingClassSet()
property viewerPage as %ZEN.Datatype.string [ InitialExpression = "Ens.Enterprise.Portal.MsgBankViewer.zen" ];
Property methods: viewerPageDisplayToLogical(), viewerPageGet(), viewerPageIsValid(), viewerPageLogicalToDisplay(), viewerPageLogicalToOdbc(), viewerPageNormalize(), viewerPageSet()

Methods

method %OnAfterCreatePage() as %Status [ Language = objectscript ]
Decorate the page.
method BuildClientData() as %Status [ Language = objectscript ]
Build the list of available clients and nodes.
method BuildItemData(pClientName As %String, pUpdateClient As %Boolean = 0) as %String [ Language = objectscript, ZenMethod ]
Build the list of available config items for a given client. pUpdateClient indicates whether the update should be sent to the client using Javascript or whether data should be stored in the multidimensional %Targets property while displaying the table on the server.
method DrawHTMLFields(tSessionId As %String) as %Status [ Language = objectscript ]
Provide HTML for selected messages.
method OnDrawRibbon() as %Status [ Language = objectscript ]
Add Resend options to the toolbar.
method ReallyResend() as %String [ Language = objectscript, ZenMethod ]
method RenderClientData(ByRef pParameters As %String) as %Status [ Language = objectscript ]
Represent the client array using JSON.
clientmethod chooseTarget() [ Language = javascript ]
Select the client to resend messages to, and trigger an update of the available config items.
clientmethod chooseTargetItem(itemName) [ Language = javascript ]
The user has chosen a target configuration item.
clientmethod getClient(nodeName) [ Language = javascript ]
Get the named client data.
clientmethod getEditURL() [ Language = javascript ]
clientmethod onloadHandler() [ Language = javascript ]
Initialise the _configItems object
clientmethod reportResendMessage() [ Language = javascript ]
Inform the user about the current targeting state.
clientmethod showNodeHomePage(nodeName) [ Language = javascript ]
clientmethod updateTargetItemList() [ Language = javascript ]
Refresh the list of available configuration items based on the currently selected client system.
clientmethod updateTargets() [ Language = javascript ]

Inherited Members

Inherited Properties

Inherited Methods

Feedback