presStatesReached message

The PresentmentStateChange event occurs when the state of a batch (ICL) changes. For example, when a batch (ICL) finishes loading in the Transaction Server, the state of the batch (ICL) changes to loaded and a PresentmentStateChange event occurs. The presStatesReached message can also depend on the PresentmentColumnChange or PresentmentGroupColumnChange events.

Configure the scheduler XML file so the class is called when one of these events occurs. The class name is:

paydir.ima.txsvr.event.appbridge.PresentmentReadyEventHandler

The PresentmentReadyEventHandler class creates the presStatesReached message to be sent to the Distribution engine. Before the message is sent, PresentmentReadyEventHandler updates outbound ready to 1, which indicates that the batch (ICL) is ready for distribution. When the Distribution engine receives the presStatesReached message, it looks for all eligible transactions in the specified batch (ICL) that are ready to be mapped to an outbound batch (ICL). After all of these transactions are mapped to an outbound batch (ICL), outbound ready is changed to 2, which indicates that Distribution mapping is complete.

The msgType parameter defines the type of message to send, presStatesReached. The <PARAMETERREF> entries define the properties that are needed to send a message to the Distribution engine. Each presStates parameter defines the batch (ICL) states that must be met for the message to be sent.

The following example XML shows a sample definition for sending a presStatesReached message.

<EVENT>
   <NAME>Distribution - Batch</NAME>
   <TYPE>PresentmentStateChange</TYPE>
   <TYPE>PresentmentColumnChange</TYPE>
   <TYPE>PresentmentGroupColumnChange</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.PresentmentReadyEventHandler
   </EXEC>
   <PARAMETER name="workType">Present</PARAMETER>
   <PARAMETER name="msgType">presStatesReached</PARAMETER>
   <!-- presStates for Check -->
   <PARAMETER name="presStates#">BALANCED</PARAMETER>
   <PARAMETER name="outboundReady">!2</PARAMETER>
   <PARAMETER name="group.condition">ACCEPTED</PARAMETER>
   <PARAMETER name="inbound.condition">ACCEPTED</PARAMETER>
   <PARAMETER name="condition">ACCEPTED</PARAMETER>
   <PARAMETER name="pending">N</PARAMETER>
   <PARAMETER name="group.pending">N</PARAMETER>
   <PARAMETER name="presLevel">PROC</PARAMETER>
   <PARAMETER name="paymentStandard">!8</PARAMETER>
   <PARAMETERREF>schedulerReferenceProperties</PARAMETERREF>
   <PARAMETERREF>sendToDistribution</PARAMETERREF>
</EVENT>

Batch levels

The level of batches (ICLs) that are normally processed by Distribution is processing batches (ICLs), which is indicated by the value PROC in the presLevel parameter of the event stanza. You can use inbound batches (ICLs) for the presStatesReached message only when all of your inbound batches (ICLs) have a single processing batch (ICL). That is, if all of the work in an inbound batch (ICL) is to be processed on a single day, that inbound batch (ICL) has only one processing batch (ICL).

If your institution does not support processing a single incoming batch (ICL) for multiple business days, you can use INB for the presLevel parameter instead. Using INB, for inbound, updates the outbound ready status on the inbound batches / ICLs and the processing batches / ICLs pages. When multiple business days are allowed, INB causes transactions to not be distributed properly because any inbound batches (ICLs) that have multiple processing batches (ICLs) associated with them result in an error.

For more information about the difference between inbound and processing batches, see Inbound and processing batch (ICL) overview.