FileTrackingEventHandler

The FileTrackingEventHandler handles the FileTrackingStateChange event. This event only occurs when the released or transmitted states in the file_tracking table are changed.

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

This event handler issues a Messaging API message on the JMS send queue when a file tracking entry reaches a specified state configuration and all the other criteria specified is met.

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 parameters correspond to columns in the file_tracking table.

Table 1 shows the additional event parameters for the file tracking event handler.

Table 1. FileTrackingEventHandler parameters
Parameter name	Trigger	Type	Value	Description
states	Yes	String	RELEASED TRANSMITTED	A comma delimited list of file tracking state column names. This parameter is required.
processName	No	String	User defined	A comma delimited set of file tracking process names. This parameter is optional.
uowType	No	String	BUSINESS_DAY_ID PAYMENT_ID PRESENTMENT_GROUP_ID PRESENTMENT_ID SEGMENT_ID ENTRY_ID	A comma delimited set of unit of work type codes. This parameter is optional.
triggerType	No	String	SCHEDULER EVENT MANUAL	A comma delimited set of trigger type codes. This parameter is optional.
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 FileTrackingEventHandler
Message part	Value	Description
Unit of Work	File Tracking Entry ID as a long	This value is used to locate the file tracking entry in the database.
Payload	RELEASED TRANSMITTED	The name of the file tracking state that changed in order to trigger this event.

Note: The contents of this message must match what the receiver is expecting.

Response processing

A response is required only if the file tracking entry that changed has a business day associated with it. Responses for all other file tracking entries are ignored.

Example handler XML

The following example XML shows a fileReleased Messaging API message sent to the FILE_TRACKING.QUEUE on localhost. The message is sent when the RELEASED state is set for a file tracking entry having a unit of work type of PRESENTMENT_ID and a trigger type of either EVENT or MANUAL.

<EVENT>
   <NAME>File Tracking Entry Released</NAME>
   <TYPE>FileTrackingStateChange</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.FileTrackingEventHandler
   </EXEC>
   <PARAMETER name="msgType">fileReleased</PARAMETER>
   <PARAMETER name="states">RELEASED</PARAMETER>
   <PARAMETER name="uowType">PRESENTMENT_ID</PARAMETER>
   <PARAMETER name="triggerType">EVENT,MANUAL</PARAMETER>
   <PARAMETER name="destinationID">File Tracking Services</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">FILE_TRACKING.QUEUE</PARAMETER>
</EVENT>