SendEndOfDayFilesEventHandler

The SendEndOfDayFilesEventHandler handles the SendEndOfDayFilesEvent.

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

This event handler issues a Messaging API message on the JMS send queue when a business day send end of day files process is requested. If configured, the message is issued to notify the target application that sending end of day files is occurring and to take the appropriate action.

The send end of day files event handler creates the send end of day message. The message is sent to the Distribution engine when the send end of day business day process is requested. The message type parameter must be set to sendEODFiles.

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 send end of day files event handler.
Table 1. SendEndOfDayFilesEventHandler parameters
Parameter name Trigger Type Value Description
categories No String User defined Comma delimited set of business day categories any of which is required for the Messaging API message to be sent.

For additional options available with this parameter, see Specifying Value Modifiers and Special Values.
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 SendEndOfDayFilesEventHandler
Message part Value Description
Unit of work Business day ID as a long Used to locate the business day just completed in the database
Contents XML that describes the business day Provides more information, such as the business date, category, and site, about the business day. An example of the XML for the contents is:
<contents>
   <businessDay>
      <site>0</site>
      <category>NACHA</category>
      <date>20170317</date>
   </businessDay>
</contents>

Response processing

The SendEndOfDayFilesEventHandler does not expect a reply.

Example handler XML

The example XML shows a sendEODFiles Messaging API message sent on the FXH.DISTRIBUTION.INPUT.QUEUE on localhost when a send end of day files event occurs. 
<EVENT>
   <NAME>Presentment - Business Day Send EOD Files</NAME>
   <TYPE>SendEndOfDayFilesEvent</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.SendEndOfDayFilesEventHandler
   </EXEC>
   <PARAMETER name="msgType">sendEODFiles</PARAMETER>
   <PARAMETER name="destinationID">Presentment</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.DISTRIBUTION.INPUT.QUEUE</PARAMETER>
   <PARAMETER name="jmsReplyQueue">FXH.TRANSSERVER.SYNC.REPLY.QUEUE</PARAMETER>
</EVENT>