OutPresentmentGroupStatesEventHandler

The OutPresentmentGroupStatesEventHandler handles the OutPresentmentGroupState event.

EXEC specification: com.ibm.paydir.ima.txsvr.event.appbridge.OutPresentmentGroupStatesEventHandler

This event handler issues a Messaging API message on the JMS send queue when an outbound transmission reaches a specified set of states. The event handler requires that at least one set of states be specified.

Event parameters

This event handler uses the general Messaging API event handler parameters and parameters that are specific to the event. Event parameters are specified in the Scheduler.xml file.

The following table shows the additional event parameters for the out presentment group states event handler.
Table 1. OutPresentmentGroupStatesEventHandler parameters
Parameter name Trigger Type Value Description
presStates1 … presStatesN Yes String
  • FILE_CREATED
  • RELEASED
  • SENT
  • NOTIF_SENT
  • HOLDOVER
  • ACCOUNTED
  • BILLED
  • REROUTED
  • SETTLEMENT_LOADED
 Comma delimited list of outbound transmission state column names. For more information about using this parameter, see Specifying Triggers.
distributionType No String
  • ENDPOINT
  • SIDEPOINT
  • REVERSAL
  • REMAKE
 The distribution type of the outbound transmissions that cause the event handler to run.
Note: The following list describes what the value in the trigger column means:
Yes
When the value in this column in the database changes to one of the values that are allowed by the event stanza, the handler places a message on the specified queue.
No
When the value in this column in the database changes, it does not cause a message to be placed on a queue. This parameter can be added to provide more criteria that must be met to send a Messaging API message.
N/A
The parameter is not considered when it is being determined whether a message is sent.

Message contents

When the message is delivered to the target application, it contains the information that is shown in Table 2.
Table 2. Message content for OutPresentmentGroupStatesEventHandler
Message part Value Description
Unit of Work Batch (ICL) group ID as a long This value is used to locate the outbound batch (ICL) in the database.
Payload com.ibm.paydir.ima.txacc.app.bridge.OutPresentmentGroupStatesEventPayload The OutPresentmentGroupStatesEventPayload class is an example of the type of payload for this event handler.
Contents XML that provides additional information about the outbound transmission Provides more information about the outbound transmission, such as the states that caused this event handler to run and the object ID in the database for the transmission. An example of the XML for the contents is:
<contents>
   <outTransmission>
      <states>
         <state>SENT</state>
      </states>
      <objId>1007</objId>
   </outTransmission>
</contents>
Note: The contents of this message must match what the receiver is expecting.

Response processing

The OutPresentmentGroupStatesEventHandler always expects a reply.

Example handler XML

The example XML shows a userMessage Messaging API message sent on the MY.QUEUE on localhost when the sent state becomes set for the outbound transmission. 
<EVENT>
   <NAME>User Queue Dispatch</NAME>
   <TYPE>OutPresentmentGroupState</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.OutPresentmentGroupStatesEventHandler
   </EXEC>
   <PARAMETER name="msgType">userMessage</PARAMETER>
   <PARAMETER name="presStates1">SENT</PARAMETER>
   <PARAMETER name="sourceID">PDTXS-03</PARAMETER>
   <PARAMETER name="destinationID">MY MESSAGE PROCESSOR</PARAMETER>
   <PARAMETER name="jmsQmgrHostname">localhost</PARAMETER>
   <PARAMETER name="jmsQmgrChannel">SYSTEM.DEF.SVRCONN</PARAMETER>
   <PARAMETER name="jmsQmgrPort">1414</PARAMETER>
   <PARAMETER name="jmsClient">true</PARAMETER>
   <PARAMETER name="jmsQmgrName">FTM.QMANAGER</PARAMETER>
   <PARAMETER name="jmsSendQueue">MY.QUEUE</PARAMETER>
   <PARAMETER name="jmsReplyQueue">MY.REPLY.QUEUE</PARAMETER>
</EVENT>