Message formats

The Transaction Server uses the scheduler.xml and the associated scheduler-fragment xml files to determine when to send messages to other applications.

All messages consist of an XML message beginning with a <ibmPaymentsDirectorBridge> element. The elements with the <ibmPaymentsDirectorBridge> element are shown in the following list.
  • <header>
  • <payload>
  • <contents>. This element is present within <ibmPaymentsDirectorBridge> element sometimes only.
The different formats of the message payload are shown in the following list.
  • Serialized Java object
  • Human readable information
These messages are proprietary to FTM and related to the PFS portion of FTM.

You can sometimes send a Common Base Event (CBE) message format instead of the proprietary application bridge format. IBM® App Connect Enterprise workflows can consume the CBE message format easily. CBE formatted messages support is added to Application Bridge event handlers on an as-needed basis when IBM App Connect Enterprise workflows are also updated to consume them.

The conditions to send a CBE message instead of an application bridge message is shown in the following list.
  • An <EVENT> stanza needs to specify the following parameter name.
    <PARAMETER name="msgFormat">CBE</PARAMETER>
    .
  • msgType value of the <EVENT> stanza need to correspond to one of the supported CBE event names that are documented here.
If the msgFormat property is not supported for an event handler, that event handler does not support sending CBE messages. CBE messages always require a corresponding row in the OBJ_BASE tables. If the FTM Base tables are not used for a payment scheme, CBE messages are not supported.
The event handlers that are enhanced to allow the msgFormat parameter to send CBE messages are shown in the following list.
  • PresentmentExceptionsEventHandler
  • PresentmentGroupEventHandler
  • PresentmentStatesEventHandler
  • PaymentExceptionEventHandler

When event handlers are configured to send a CBE message instead of an application bridge message, the associated work-in-progress records are automatically marked as complete. If the message is successfully placed on the specified queue, no response is required or expected.