UC_UTILITY_ARCHIVE - Configuring the Archiving Parameters

This variable (VARA) object is available in Client 0 and it contains the configuration parameters for archiving the following operational data: Execution data (formerly known as statistics), messages, reports and comments). There are various ways of archiving data; Depending on which method you choose, one of the following is true:

Archiving through the REST API or AWI

This variable is available in Client 0. You must configure some of the keys in the variable for the archiving process to succeed. The list below indicates whether a key is relevant when archiving through AWI/REST API or not.
Archiving with the AE DB Archive Utility

You can configure all the parameters in this variable through the Utility user interface. The Utility then modifies this variable automatically in Client 0 with the values you enter there.

This variable includes the following keys:

AH

Relevant for all archiving methods.

Description: Determines whether execution data (formerly known as statistics) will be archived or not and, if yes, for how long. With the execution data, the Utility also archives all the comments that operators add to the execution data when monitoring them.

Format: flag days
- flag1: Whether execution data will be archived.
  - TRUE: Archive data
  - FALSE: Do not archive data
- days: Data that are older that the number of days specified here will be archived.
Examples:

TRUE 0001 means that data that are older than 1 day will be archived. This is the recommended setting.

TRUE 0000 means that data will be archived as soon as they are available.
AH_BODY

Relevant when archiving through AWI/REST API.

Description: Determines the database tables from which data will be archived.

Example: AH_NAME,AH_TIMESTAMP1,AH_TIMESTAMP2,AH_TIMESTAMP4,AH_ARCHIVE1,AH_ARCHIVE2 means that the data in the addressed Name, Timestamp and Archive columns will be archived.
ARCHIVSET

Relevant when using the AE DB Archive Utility only.

Description: Number of archive runs that have been processed so far. This value is also used as part of the archive folder name.

Note: This parameter is not available if you archive data using the REST API.
FORMAT

Relevant for all archiving methods.

Description: Determines the date and time format that will be used in the archive records.
LASTAHRH

Relevant when using the AE DB Archive Utility only.

Description: Last archiving date of execution data and reports.

Format: YYYYMMDD
LASTMELD

Relevant when using the AE DB Archive Utility only.

Description: Last archiving date of messages.

Format: YYYYMMDD
MELD

Relevant for all archiving methods.

Description: Determines how far back the Utility will go to archive messages.

Format: flag days1 days2
- flag: Whether messages will be archived or not.
  - TRUE: Archive messages.
  - FALSE: Do not archive messages.
- days1: Archive read messages that are older than.
- days2: Archive unread messages that are older than.
Example: TRUE 0000 0001 means that read messages will be archived as soon as they arrive; unread will be archived when they are 1 day old.
PATH

Relevant when using the AE DB Archive Utility only.

Description: Directory in which the archive files will be stored when you download them. For example /home/user1/.
SIZE

Relevant when using the AE DB Archive Utility only.

Description: Determines the maximum size that an archive file can reach before a new set of files is created. When the archive reaches the size specified here, it splits off into a new file set.

Default: 650 MB.

Note: This parameter is not available if you archive data using the REST API.
SIZEAH, SIZEMELD, SIZERH, TIMEAH, TIMEMELD, TIMERH

Relevant when using the AE DB Archive Utility only.

Description: Data size and duration of the last archiving run. These values are used as predictors for the forecast calculation of the next archiving run.