Transaction Server notifying the Distribution engine

The Transaction Server scheduler uses Messaging API event configurations to provide the messages the Distribution engine processes. The messages need to be sent to the queue where the Distribution engine listens for Transaction Server notifications. These events are defined in the Scheduler.xml file. For more information about using the events, see Events and communication with external applications.

This example XML shows the configuration for a typical Distribution engine notification setup: 
<EVENT>
   <NAME>Distribution Profile - States Reached</NAME>
   <TYPE>PresentmentStateChange</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.PresentmentReadyEventHandler
   </EXEC>
   <PARAMETER name="msgType">presStatesReached</PARAMETER>
   <PARAMETER name="parmFileName">PresentmentProfile.properties</PARAMETER>
   <PARAMETER name="presStates1">BALANCED</PARAMETER>
   <PARAMETER name="presStates2">BALANCED,REVIEWED</PARAMETER>
   <PARAMETER name="presStates3">BALANCED,REPAIRED</PARAMETER>
</EVENT>
<EVENT>
   <NAME>Distribution Profile - Payment Ready</NAME>
   <TYPE>PaymentExceptionChange</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.PaymentReadyEventHandler
   </EXEC>
   <PARAMETER name="msgType">paymentReady</PARAMETER>
   <PARAMETER name="parmFileName">PresentmentProfile.properties</PARAMETER>
   <PARAMETER name="minPresStates">BALANCED</PARAMETER>
</EVENT>
<EVENT>
   <NAME>Distribution Profile - End of Day Check</NAME>
   <TYPE>EndOfDayCheck</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.EndOfDayCheckEventHandler
   </EXEC>
   <PARAMETER name="msgType">endOfDayCheck</PARAMETER>
   <PARAMETER name="parmFileName">PresentmentProfile.properties</PARAMETER>
</EVENT>
<EVENT>
   <NAME>Distribution Profile - Business Day Purge</NAME>
   <TYPE>BusinessDayPurgeEvent</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.PurgeEventHandler
   </EXEC>
   <PARAMETER name="msgType">purgeBusinessDay</PARAMETER>
   <PARAMETER name="parmFileName">PresentmentProfile.properties</PARAMETER>
   <PARAMETER name="purgeEventType">2</PARAMETER>
</EVENT>

Several parameters that are common to all Messaging API events must be configured. For more information about how to specify these parameters, see Setting Up a Messaging API Event Handler.

The following sections describe the events that are configured in the example XML.

PresentmentStateChange event for batch (ICL) state changes

When a batch (ICL) reaches a specific set of states, the PresentmentReadyEventHandler is configured to send a notification to the specified message queue. This notification enables the Distribution engine to react when all of the state sets configured in the scheduler XML are reached.

The sample XML shows the configuration that is needed to send a presStatesReached message to Distribution when a PresentmentStateChange event occurs. The event handler posts a message for each batch (ICL) that is BALANCED, or BALANCED and REVIEWED, or BALANCED and REPAIRED. The message contents for this event are shown in the following list:
  • The unit of work contains the batch (ICL) ID of the batch (ICL) whose state was set.
  • The payload contains the comma-delimited set of states that were reached.
In this example, the payload contains one of the following, depending on the state set being reported:
  • BALANCED
  • BALANCED,REVIEWED
  • BALANCED,REPAIRED
More than one message can be sent if the individual state that is being set is included in multiple state sets that are simultaneously reached. If a failure occurred delivering the presStatesReached message, a corresponding WIP record can be located by using the Control Center. The Control Center can be used to have the message be resent to its target destination.
Note: At least one Transaction Server listener must be configured so that the Transaction Server can receive and process the corresponding AppBridgeServiceResponse messages and then mark the corresponding WIP record complete.

For more information about using the PresentmentReadyEventHandler, see PresentmentReadyEventHandler.

Payment ready

The sample XML shows the configuration that is needed to send a paymentReady message to Distribution when a PaymentExceptionChange event occurs. The event handler posts the message when the transaction is BALANCED.

For more information about using the PaymentReadyEventHandler, see PaymentReadyEventHandler.

End of day check

When the Transaction Server receives a request to do an end of day task for a specified business day, it can notify any number of external applications. The Transaction Server uses the EndOfDayCheckEventHandler to notify applications that the end of day processing is occurring.

The sample XML shows the configuration that is needed to send an endOfDayCheck message to Distribution when an EndOfDayCheck event occurs. No additional parameters are needed by this event handler.

Alternately, the event handler can be temporarily unconfigured and the end of day task can be run without requiring notification of the Distribution engine.

For more information about using the EndOfDayCheckEventHandler, see EndOfDayCheckEventHandler.

Business day purge

The sample XML shows the configuration that is needed to send a purgeBusinessDay message to Distribution when the Transaction Server purges the data for a business day.

For more information about using the PurgeEventHandler, see PurgeEventHandler.