PaymentAddedEventHandler

The PaymentAddedEventHandler handles the PaymentAddedEvent event.

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

This event handler issues a Messaging API message on the JMS send queue when a transaction that matches each of the values that are specified in the event parameters is added. For example, specifying a value of 820 for the inPaymentMsgType parameter causes the handler to put a message on the send queue when a transaction with that inbound message type is added. Transactions that are added with other message types are ignored.

The PaymentAddedEvent is only created for acknowledgment records or transactions that are inserted in the following ways:

UpdateServices.applyUpdates was called.
An applyUpdates message was sent to the Transaction Server with a BlockInsertBean, BlockModelInsertBean, or PaymentInsertBean that has the sourceComponent field set.

During testing, you can verify whether a PaymentAddedEvent occurred by using the debug mode attribute (<EVENT mode="debug">) to create a log message when a payment that causes a PaymentAddedEvent is added.

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 added event handler.

Table 1. PaymentAddedEventHandler parameters
Parameter name	Trigger	Type	Value	Description
sourceComponents	No	String		A comma-delimited list of source components. The target applications that use the PaymentInsertBean to add transactions define the source components. For more information about the value to use for this parameter, see the documentation for each target application. Note: The options that are described in Specifying Value Modifiers and Special Values are not available for this parameter.
recordType	No	short	Example values are shown in the following list: 125 !208	Specify the record type for the event. Use the not indicator to cause the event handler to run for all transactions that do not have the specified record type. For more options available with this parameter, see Specifying Value Modifiers and Special Values.
endpoint	No	String	Example values are shown in the following list: ^COPAYA NULL !NULL	Specify the endpoint for the event. Use the not indicator to cause the event handler to run for all transactions that do not have the specified endpoint. Use the NULL indicator to cause the event handler to run for all transactions that do not have an assigned endpoint. For more options available with this parameter, see Specifying Value Modifiers and Special Values.
paymentMessageType	No	short	Example values are shown in the following list: 820 ~824	This parameter was replaced by inPaymentMsgType, which is to be used for new event configurations. paymentMessageType is still supported for existing event configurations.
onus	No	boolean	TRUE, YES, 1 FALSE, NO, 0	Specify the on-us indicator for the event. Use the not indicator to cause the event handler to run for all transactions that do not have the specified on-us value. For more options available with this parameter. By default, the ignore case option is not available for this parameter, see Specifying Value Modifiers and Special Values.
inPaymentStandard	No	Short	N/A	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 can be specified. For more information about using the not indicator, see Specifying Value Modifiers and Special Values.
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: CPA 005	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		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

When the message is delivered to the target application, it contains the information that is shown in the following table.

Table 2. Message content for PaymentAddedEventHandler
Message part	Value	Description
Unit of Work	Transaction ID as a long	This value is used to locate the transaction in the database.
Payload	The source component and an optional ABSvcPayload	The source component for the transaction that was added. If the optional ABSvcPayload parameter is also sent, the source component is followed by a comma and then the ABSvcPayload parameter. For more information about the ABSvcPayload event handler parameter, see the general Messaging API event handler parameters.

Note: The contents of this message must match what the receiver is expecting.

Response processing

Any response from the target application is ignored.