Ens.Enterprise.MsgBank.Targeting

abstract class Ens.Enterprise.MsgBank.Targeting

APIs for automatic target selection when resending messages from the Message Bank

Method Inventory

AllMessages()
DisableCollectiveTargeting()
DisableIndividualTargeting()
EnableCollectiveTargeting()
EnableIndividualTargeting()
GetCurrentConfig()
IndividualMessage()
SetCallbackClass()

Methods

abstract classmethod AllMessages(pGlobalCounter As %Integer, Output pNewNode As %String, Output pNewItem As %String) as %Status

This is a stub for a callback to redirect a group of messages supplied to the Enterprise Message Bank resend pages. Note that all of the messages will be resent to the target speficied in this callback. The method must return the new target and/or node in the two output parameters pNewNode and pNewItem. These should be left as "" to leave the targets as per the original messages. It is also important to note that pGlobalCounter is a reference to the node in ^IRIS.Temp.ResendIDs being used to process messages. The message IDs are all stored in nodes immediately below the supplied reference, so you need to $order over ^IRIS.Temp.ResendIDs(pGlobalCounter,) to retrieve all the message IDs.

final classmethod DisableCollectiveTargeting() as %Status

Disables Collective Targeting in the current namespace.

final classmethod DisableIndividualTargeting() as %Status

Disables Individual Targeting in the current namespace.

final classmethod EnableCollectiveTargeting(pCallbackClass As %String = "") as %Status

Enables Collective Targeting in the current namespace. If pCallbackClass is supplied, this will be used as the callback class for all automatic resend targeting

final classmethod EnableIndividualTargeting(pCallbackClass As %String = "", pForce As %Boolean = 0) as %Status

Enables Individual Targeting in the current namespace. If pCallbackClass is supplied, this will be used as the callback class for all automatic resend targeting. If pForce is true, then Collective Targeting will be disabled. This allows one to ensure that Individual Targeting does occur.

final classmethod GetCurrentConfig(Output pCallbackClass As %String, Output pIndividual As %Boolean, Output pCollective As %Boolean, ByRef pIsValid=1) as %Status

Retrieves the current settings as output variables. By default, it will also validate the configuration and output any errors in pIsValid.

abstract classmethod IndividualMessage(pMessageHeaderId As %Integer, Output pNewNode As %String, Output pNewItem As %String) as %Status

This is a stub for a callback to redirect specific messages supplied to the Enterprise Message Bank resend pages. The method should return the new target and/or node in the two output parameters pNewNode and pNewItem. These should be left as "" to leave the target as the original.

final classmethod SetCallbackClass(pCallbackClass As %String = "") as %Status

Sets the callback class for both Individual and Collective Targeting in the current namespace. If pCallbackClass isn't supplied, the value is set to ""