This function causes a transaction directory of a completed queued transaction to be placed in the transaction archive (according to com.arbortext.e3.transactionArchive.enable and com.arbortext.e3.transactionArchive.selector global parameters in e3config.xml). Immediately after copying the transaction directory to the archive, it’s deleted from the Active Transaction Directory and the transaction is no longer an active transaction. This intent of this function is to allow an application to clean up the directory after retrieving the result of a queued transaction.

Consider a user consulting a list of completed transactions using a web browser or some other client application. As transactions finish, they appear on the list. The user can then retrieves the results of each transaction. This function would prevent the list from becoming mostly transactions for which the user has already retrieved the results. Transactions are removed after a configured interval (as set by the com.arbortext.e3.transaction.maxRetrievedTransactionAge global parameter in e3config.xml).

This function acts on the transaction regardless whether the results from a transaction have been retrieved or not. This action allows users to clear the list of unwanted transactions without retrieving unwanted results.

If this request specifies an immediate request, a queued transaction that has not executed, or if the id parameter does not identify an active transaction, this function will return an error.