This group provides a helper methods to call a sequence of methods within context of transaction.
Every POA operation that modifies POA state is one (or, rarely, several) transaction. A number of operations (i.e. – create Account, create Staff Member for the Account, subscribe created Account to Service Template, schedule provisioning of website) can be combined into one transactional operation. For this purpose there exist the following methods: txn.Begin, txn.Commit. To be able to rollback any transaction, use txn.Rollback method.
Each transaction has the
txn_idparameter, that can be specified when beginning transaction. If
txn_id is not specified, POA generates it. The
txn_id parameter should be unique, it is used to further reference the transaction.
txn_id parameter can be specified with every POA Public API method (except pem.batchRequest or pem.getRequestStatus). It will mean that such method belongs to a transaction.
After the transaction is commited or is rolled back, its
txn_id parameter becomes invalid and cannot be used for further operations.
To obtain the overall status of tasks scheduled after transaction commit or after the pem.batchRequest execution, the pem.getRequestStatus method can be used.