TMM_GET_TX_STATUS Function

7.14.7.2 TMM_GET_TX_STATUS Function

Used by a transaction initiator application to retrieve the current transaction status.

Syntax

TMM_GET_TX_STATUS (
   microTxTransaction IN MicroTxTransaction,
   forwardHeaders     IN ForwardHeaders DEFAULT NULL)
RETURN VARCHAR2(64);

TMM_GET_TX_STATUS Function Parameters

Parameter Description

microTxTransaction Mandatory parameter. The MicroTxTransaction object that the TMM_BEGIN_TX function returns.

Parameter	Description
`microTxTransaction`	Mandatory parameter. The `MicroTxTransaction` object that the `TMM_BEGIN_TX` function returns.
`forwardHeaders`	Optional. The application forwards the specified headers to the MicroTx coordinator, and then the coordinator uses these headers while communicating with the application. An application can forward the following headers: authorization token, transaction token, and a unique ID to trace the transaction across the microservices. If you have enabled authorization by setting `tmmConfiguration.authorization.authTokenPropagationEnabled` to `true` in the `values.yaml` file for the coordinator, your application must forward the authorization token. If you have set `tmmConfiguration.transactionToken.transactionTokenEnabled` to `true` in the `values.yaml` file for the coordinator, your application must forward the transaction token.

forwardHeaders

Optional. The application forwards the specified headers to the MicroTx coordinator, and then the coordinator uses these headers while communicating with the application. An application can forward the following headers: authorization token, transaction token, and a unique ID to trace the transaction across the microservices.

If you have enabled authorization by setting tmmConfiguration.authorization.authTokenPropagationEnabled to true in the values.yaml file for the coordinator, your application must forward the authorization token.

If you have set tmmConfiguration.transactionToken.transactionTokenEnabled to true in the values.yaml file for the coordinator, your application must forward the transaction token.

Return Values

Returns a VARCHAR2(64) value, which contains the status of the transaction for the specified MicroTxTransaction object.

Examples

The following sample code demonstrates how you can get the current transaction status using the TMM_GET_TX_STATUS function.

tx_status = TMM_GET_TX_STATUS (l_microTxTransaction, l_forwardheaders);

Where, l_microTxTransaction is the name of the MicroTxTransaction object that the TMM_BEGIN_TX function returns and l_forwardheaders that the headers that the application forwards.

Parent topic: MicroTx PL/SQL Library Functions