Transaction services

Use Transaction services only in conjunction with Database Connector operations. These services are applicable when the Database Connector account is of type Transactional.

commit

Commits an explicit transaction.

Input parameters for commit

  • commitTransactionInput: Document. Information for each commit request.
  • transactionName: String. The name of an explicit transaction that you want to commit. The transactionName must have been previously used in a call to Transaction:start. This value must be mapped from the most recent Transaction:start that has not previously been committed or rolled back.

Output parameters for commit

None.

Usage notes for commit

This service must be used in conjunction with the Transaction:start service. If the transactionName parameter was not provided in a prior call to Transaction:start, a run-time error will be returned.

rollback

Rolls back an explicit transaction.

Input parameters for rollback

  • rollbackTransactionInput: Document List. Information for each rollback request.
  • transactionName: String. The name of an explicit transaction that you want to roll back. The transactionName must have been previously used in a call to Transaction:start. This value must be mapped from the most recent Transaction:start that has not previously been committed or rolled back.

Output parameters for rollback

None.

Usage notes for rollback

This service must be used in conjunction with the Transaction:start service. If the given transactionName

setTimeout

Manually sets a transaction timeout interval for implicit and explicit transactions.

Input parameters for setTimeout

timeoutSeconds: Integer. The number of seconds that the implicit or explicit transaction stays open before the transaction manager marks it for rollback.

Output parameters for setTimeout

None.

Usage notes for setTimeout

You must call this service before you call the Transaction:start service. If the execution of a transaction takes longer than the transaction timeout interval, all transacted operations are rolled back.

start

Starts an explicit transaction.

Input parameters for start

  • startTransactionInput: Document. Information for each start transaction request.
  • transactionName: String. Specifies the name of the transaction to be started. If you leave this parameter blank, the Database Application will generate a name for you. In most implementations it is not necessary to provide your own transaction name.

Output parameters for start

  • startTransactionOutput: Document. Information for each start transaction request.
  • transactionName: String. The name of the transaction the service just started.

Usage notes for start

This service is intended for use with the Transaction:commit or Transaction:rollback service. The transactionName value returned by a call to this service can be provided to Transaction:commit (to commit the transaction) or Transaction:rollback (to roll back the transaction).