ScheduledPaymentExecStatesEventHandler

The ScheduledPaymentExecStatesEventHandler handles the ScheduledPaymentExecStateChange event.

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

This event handler issues a Messaging API message on the JMS send queue when the ScheduledPaymentExecStateChange event occurs. If configured, a message is sent when scheduled payments or notifications need to be sent.

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 following table shows the additional event parameters for the scheduled payment state change event handler.

Table 1. ScheduledPaymentExecStatesEventHandler parameters
Parameter name	Trigger	Type	Value	Description
stateName	Yes	String	STARTED PAYMENT_COMPLETE NOTIFIED	The event handler sends the Messaging API message when the state of the scheduled payment processing changes to the state specified in this parameter. The states are described in the following list. STARTED The scheduled payment processing started because a record was inserted into the table. PAYMENT_COMPLETE All scheduled payments for the payment schema were processed. NOTIFIED Notification processing was run.
paymentSchema		String	TCH	Indicates which payment schema that this scheduled payment event handler is for.
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.

Example handler XML

The following example XML shows a scheduledPaymentsExecStateChange Messaging API message that is sent on the FXH.TRANSSERVER.SCHEDPAY.QUEUE when a ScheduledPaymentExecStateChange event occurs.

<EVENT>
   <NAME>TCH - Scheduled Payments Initiation</NAME>
   <TYPE>ScheduledPaymentExecStateChange</TYPE>
   <EXEC>
      com.ibm.paydir.ima.txsvr.event.appbridge.ScheduledPaymentExecStatesEventHandler
   </EXEC>
   <PARAMETER name="msgType">scheduledPaymentsExecStateChange</PARAMETER>
   <PARAMETER name="stateName">STARTED</PARAMETER>
   <PARAMETER name="paymentSchema">TCH</PARAMETER>
   <PARAMETERREF>schedulerReferenceProperties</PARAMETERREF>
   <PARAMETERREF>sendToTransactionServerSchedPay</PARAMETERREF>
</EVENT>