MoveUowEventHandler

The MoveUowEventHandler handles the MoveUowEvent event.

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

This event handler issues a Messaging API message on the JMS send queue when a unit of work (UOW) with the UOW type or types specified in the event parameters is moved to a new business day. For example, specifying PAYMENT_ID as the unit of work type parameter causes a message to be sent when a transaction is moved, but not when entries (ENTRY_ID) or batches (PRESENTMENT_ID) are moved.

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 parameters for the move UOW event handler.
Table 1. MoveUowEventHandler parameters
Parameter name Trigger Type Value Description
uowType No String
  • ENTRY_ID
  • PRESENTMENT_ID
  • PAYMENT_ID
A comma delimited set of valid unit of work types, any one of which is required for 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 MoveUowEventHandler
Message part Value Description
Unit of Work UOW The unit of work data object (UOW) to be moved to the new business day. This object provides the getter methods shown in Table 3 to retrieve the details for the unit of work.
Payload An array of UOW objects The array contains UOW objects in the following order:
  1. the parent unit of work
  2. ID of the business day from which the UOW is being moved
  3. ID of the destination business day
These objects provide the accessor methods shown in Table 3 to retrieve the details for each unit of work.
Note: The contents of this message must match what the receiver is expecting.
The data object for the unit of work has the following access methods for retrieving details about the unit of work:
Table 3. MoveUowEventHandler accessor methods
Method name Return type Description
getType ( ) String Returns the UOW type of the unit of work. Valid values are:
  • BUSINESS_DAY_ID
  • ENTRY_ID
  • PAYMENT_ID
  • PRESENTMENT_ID
  • PRESENTMENT_GROUP_ID
getValue ( ) Long Returns the unit of work ID for the unit of work

Response processing

Any response from the target application is ignored.

Example handler XML

The example XML shows a uowMoved Messaging API message sent on the FXH.RISK.INPUT.QUEUE on localhost when a batch or transaction is moved.
<EVENT>
   <NAME>Alert Risk of Batches and Transactions Moved</NAME>
   <TYPE>MoveUow</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.MoveUowEventHandler
   </EXEC>
   <PARAMETER name="msgType">uowMoved</PARAMETER>
   <PARAMETER name="uowType">PRESENTMENT_ID,PAYMENT_ID</PARAMETER>
   <PARAMETER name="sourceID">PDTXS-11</PARAMETER>
   <PARAMETER name="destinationID">MY RISK ENGINE</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.RISK.INPUT.QUEUE</PARAMETER>
   <PARAMETER name="jmsReplyQueue">FXH.TRANSSERVER.INPUT.QUEUE</PARAMETER>
</EVENT>