PresentmentGroupLoadedEventHandler

The PresentmentGroupLoadedEventHandler handles the PresentmentGroupState event.

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

This event handler issues a Messaging API message on the JMS send queue for each batch (ICL) within the transmission whose state is not the state specified by the stateName parameter.

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.

Table 1 shows the additional event parameter for the presentment group loaded event handler.
Table 1. PresentmentGroupLoadedEventHandler parameters
Parameter name Type Value Description
stateName String One of the batch (ICL) states that can be used for triggers. A single batch (ICL) state name. A message is sent for each batch (ICL) in the transmission that is not in the specified state.
Note:
  1. This is not the name of a presentment group state.
  2. The stateName parameter is required for configuration of the PresentmentGroupLoadedEventHandler.

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 PresentmentGroupLoadedEventHandler
Message part Value Description
Unit of Work Batch (ICL) ID as a long This value is used to locate the batch (ICL) in the database.
Payload Contents specified in the ABSvcPayload

The only payload delivered is the one specified using the ABSvcPayload event handler parameter as described in the general Messaging API event handler parameters.
Note: The contents of this message must match what the receiver is expecting.

Response processing

Any response from the target application is ignored.

Example handler XML

When a batch (ICL) is loaded, Transaction Server determines if the batch (ICL) has any suspects for review. If not, the batch (ICL) is marked as reviewed. If suspects are available for review, the PresentmentGroupLoaded event in the sample XML causes a reviewSuspectImages message to be placed on a message queue. The message queue is specified by the jmsSendQueue element and should be the same queue on which the Suspect Image Review components listen for notifications.

The example XML shows a reviewSuspectImages Messaging API message sent on the FXH.IMAGECOMPLIANCE.INPUT.QUEUE on localhost when a PresentmentGroupLoaded event occurs. A message is sent for every batch (ICL) within this transmission that is not yet reviewed. The unit of work for each message is the batch (ICL) ID and the payload is EXEC-REVIEW. 
<EVENT>
   <NAME>Presentment Group Loaded Event</NAME>
   <TYPE>PresentmentGroupLoaded</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.PresentmentGroupLoadedEventHandler
   </EXEC>
   <PARAMETER name="msgType">reviewSuspectImages</PARAMETER>
   <PARAMETER name="stateName">REVIEWED</PARAMETER>
   <PARAMETER name="sourceID">PDTXS-01</PARAMETER>
   <PARAMETER name="destinationID">ImageReview0001</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">FXH.IMAGECOMPLIANCE.INPUT.QUEUE</PARAMETER>
   <PARAMETER name="jmsReplyQueue">FXH.TRANSSERVER.INPUT.QUEUE</PARAMETER>
   <PARAMETER name="ABSvcPayload">EXEC-REVIEW</PARAMETER>
</EVENT>