Adding Usage Count

Transactions need to be counted for auditing and billing purposes. Usually you do not need to worry about this because the core FTM flows EndMapper and EndOutboundMapper handle the usage counting automatically. In the event that your application creates transactions that bypass EndMapper and EndOutboundMapper, the application is responsible for tracking usage correctly.

To count transactions, call the following procedure once for each transaction:

CREATE PROCEDURE CountTransaction(IN master BOOLEAN,
                                            IN inbound BOOLEAN,
                                            IN buildID CHAR,
                                            IN buildDate CHAR,
                                            IN buildTime CHAR)

This procedure has the following parameters:

master: If this boolean parameter is set to TRUE, a master¹ transaction is counted.
inbound: If this boolean parameter is set to TRUE, an inbound transaction is counted. Otherwise, an outbound transaction is counted.
buildID: The build ID of this version of FTM. It is retrieved using the function GetBuildDate() from the Common.esql file.
buildDate: The build date of this version of FTM. It is retrieved using the function GetBuildId() from the Common.esql file.
buildTime: The build time of this version of FTM. It is retrieved using the function GetBuildTime() from the Common.esql file.

¹Because the current billing and usage limits are defined within the context of master transactions, there is an official definition of a master transaction:

A master transaction is a set of instructions initiated from an application external to FTM (for example, a business banking web channel or manual message entry channel) or triggered by an event in FTM (for example, a recurring payment or time of day to start bulk processing). The master transaction manages the related business activity and logical unit of work, including all updates and events associated with the various processing steps and ending when the final instruction is sent to an external application, the processing lifecycle is complete, or both. A master transaction will initiate underlying transactions during its processing lifecycle.