The Global Transaction Archive Parameters

The following global parameters manage the transaction archive capability, described in Monitoring the Transaction Archive. Use Transaction Archive link on the Arbortext Publishing Engine index page to view the archived transactions list, described in Monitoring and Reporting Using a Web Browser, .

Specifies the directory where archive entries are stored. The default is explicitly set to the subdirectory transactionArchive, under the temporary directory specified by com.arbortext.e3.tempFileDirectory, described in The Global com.arbortext.e3.tempFileDirectory Parameter.

If your implementation will archive a large number or size of transactions, you should put the directory is a location that is not in the server’s temporary storage area. You should also periodically monitor the transactions held in the archive; see Monitoring the Transaction Archive.

Specifies the alternate directory where secure archive entries are stored. The default is explicitly set to the subdirectory alternateTransactionArchive. You can supply an absolute path to the location, or a relative path under the temporary directory specified by com.arbortext.e3.tempFileDirectory.

Specifies whether the transaction archive is enabled. By default, it’s set to true. Specify false to turn off archiving transactions.

If it is set to true, then a transaction can be archived, as determined by the com.arbortext.e3.transactionArchive.selector (set to any valid value other than none). The values of the test-archive-transaction or test-alternate-transaction-archivetest sets determine where the transaction should be archived.

Specifies whether to clear the transaction archive when Arbortext Publishing Engine starts.

◦ false (explicitly set as the default) keeps archive entries when Arbortext Publishing Engine starts.

Keeping archived entries means the archive keeps all its entries each time Arbortext Publishing Engine starts.

Specifies the maximum time in hours that an entry will remain in an archive before it is automatically deleted. A value of 0 means never delete archive entries. The default is explicitly set to 48 hours.

Specifies the maximum size in megabytes that a transaction archive may occupy on disk. If an entry causes the archive to exceed this size, entries will be deleted starting with oldest first, until the archive is less than the maximum size. A value of 0 means no deletions will be performed based upon maximum size. The default is explicitly set to 500.

Specifies the filters for determining which requests are saved in the archive, as determined by the test sets for test-archive-transaction and test-alternate-transaction-archive (see Specifying Test Sets for more information).

◦ error saves error entries, including requests with a response other than 200, requests which cause an Arbortext PE sub-process to terminate abnormally, and requests for which transmission of the response to the client fails.

◦ log (explicitly set as the default) saves error entries, as well as requests with log entries or intermediate files.

Specifies the name of the test set that identifies transactions that should be archived. This parameter is set to archive-transaction-test, the test set ID as provided by default in e3config.xml (see Specifying Test Sets for more information). The com.arbortext.e3.transactionArchive.selector parameter determines whether archiving is required.

This parameter archives transactions even if com.arbortext.e3.transactionArchive.enable is set to false.

Specifies the name of the test set that identifies transactions that should be archived in an alternate location. This parameter is set to archive-transaction-to-alternate-location-test, the test set ID as provided by default in e3config.xml (see Specifying Test Sets for more information). The com.arbortext.e3.transactionArchive.selector parameter determines whether archiving is required.

This parameter archives transactions even if com.arbortext.e3.transactionArchive.enable is set to false.

Specifies the number of seconds between execution of the transaction archive management thread. The thread checks for transactions completed since the last run, as well as for transactions older that the interval specified by com.arbortext.e3.transactionArchive.maxAge. The default is explicitly set to 10.

The thread will also check for completed transactions that should be archived, as well as archived completed requests that should be deleted, as configured by the maxCompletedTransactionAge and maxRetrievedTransactionAge parameters.