BatchDeleteEventHandler

The BatchDeleteEventHandler handles the BatchDelete event.

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

This event handler issues a Messaging API message on the JMS send queue when the BatchDelete event occurs. If configured, the message is issued during batch (ICL) delete processing to alert an application that the delete is occurring and allow it to take appropriate action.

Event parameters

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

There are no additional event parameters for this event.

Message contents

The message type can be anything required by the target application. The destinationId and ABSvcPayload event parameters are used to pass additional information to the applications.

When the message is delivered to the target application, it contains the information that is shown in Table 1.

Table 1. Message content for BatchDeleteEventHandler
Message part	Value	Description
Unit of Work	Batch (ICL) ID as a long	This value identifies the batch (ICL) that is being deleted.
Payload	Batch Delete Payload instance	The payload is an instance of the `BatchDeletePayload` class that is filled in with the batch (ICL) delete operation details. The target name field has been filled in with the value from the Messaging API destinationId parameter and the payload receives the ABSvcPayload parameter value.

Response processing

It is recommended that the target application respond to the standard deleteBatch message type value.

The Messaging API message sent to the target application is synchronous. For synchronous requests, the Transaction Server expects a response to the message and sets the response required indicator in the JMS message. The jmsReplyTimeout parameter determines how long the Transaction Server waits for the response. If a response is not received, a timeout occurs. The timeout is logged in the deposit group message table.

Example handler XML

The example XML shows a batchDelete Messaging API message sent on the FXH.SERVICESFRAMEWORK.INPUT.QUEUE on localhost.

<EVENT>
   <NAME>Post Batch (ICL) Deleted to Services Framework</NAME>
   <TYPE>BatchDelete</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.BatchDeleteEventHandler
   </EXEC>
   <PARAMETER name="msgType">batchDeleted</PARAMETER>
   <PARAMETER name="sourceID">TXS-101</PARAMETER>
   <PARAMETER name="destinationID">SERVICES-FRAMEWORK</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.SERVICESFRAMEWORK.INPUT.QUEUE</PARAMETER>
</EVENT>