PaymentUpdateEventHandler

The PaymentUpdateEventHandler handles the PaymentUpdateEvent event.

The EXEC specification is com.ibm.paydir.ima.txsvr.event.appbridge.PaymentUpdateEventHandler.

This event handler issues a Messaging API message on the JMS send queue after a transaction reaches a specified set of states and column values. A message is only sent when one of the specified states changes values but ALL of the states and columns that are specified in the stanza match the values in the database. If a parameter corresponds to a column in a database table, then that parameter determines whether a message is 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 that you can use for the payment update event handler.
Table 1. PaymentUpdateEventHandler parameters
Parameter name Trigger Type Value Description
state Yes String The payment state name that triggers the event when changed. The name of a payment state column names. For more information about using this parameter, see Specifying Triggers.

Specify the state parameter to process a PaymentUpdateEvent.
responseRequired No Boolean Example values are shown in the following list.
  • FALSE
  • TRUE

This parameter indicates whether the event handler requires the target application to return a response to complete the work in progress record in the service manager. When this parameter is true, the event handler uses the response required flag in the message to notify the target application that it must respond.

The default value of the parameter is true. This parameter is not mandatory.
deleted No Boolean
  • TRUE, Y
  • FALSE, N
 This parameter indicates whether a payment is logically deleted. If this parameter is specified, the value of the deleted column must correspond to this value for theMessaging API message to be sent.
presDeleted No Boolean
  • TRUE, Y
  • FALSE, N
 This parameter indicates whether the batch (ICL) that a payment belongs to is logically deleted. If this parameter is specified, the value of the pres_deleted column in the payment table must correspond to this value for the Messaging API message to be sent.
inPaymentStandard No Short N/A This parameter is a comma-delimited list of inbound message standard values that cause the message to be sent for a transaction. Use the not indicator to cause the message to be sent when the transaction does not have this inbound message standard value. When the not indicator is used, only a single payment standard is specified.
inPaymentMsgType No Short N/A Specify a single inbound message type that causes the message to be sent for a transaction. Use the not indicator to cause the message to be sent when the transaction does not have this inbound message type.

For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
inPaymentSchemeId No String Example values are shown in the following list:
  • RIX
  • NBO
 A comma-delimited list of inbound payment scheme IDs. The values to use for this parameter are found in the Name column of the PAYMENT_SCHEME_TYPE table.
outPaymentStandard No Short N/A Specify a single outbound message standard value that causes the message to be sent for a transaction. Use the not indicator to cause the message to be sent when the transaction does not have this outbound message standard value.

For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
outPaymentMsgType No Short N/A Specify a single outbound message type that causes the message to be sent for a transaction. Use the not indicator to cause the message to be sent when the transaction does not have this outbound message type.

For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
outPaymentSchemeId No String Example values are shown in the following list:
  • RIX
  • NBO
 A comma-delimited list of outbound payment scheme IDs. The outbound payment scheme for a payment is the same as the payment scheme of the business day associated with the processing batch. The values to use for this parameter are found in the Name column of the PAYMENT_SCHEME_TYPE table.
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

The information contained after the message is delivered to the target application is shown in the following table.
Table 2. Message content for PaymentUpdateEventHandler
Message part Value Description
Unit of Work Transaction ID as a long This value is used to locate the transaction in the database.
Payload State The name of the state that triggered the message.
Note: The contents of this message must match what the receiver is expecting. For example, this event handler may be used to send a paymentReady msgType to Distribution to indicate that an individual payment is now ready.

Response processing

Any response from the target application is ignored.