[history-log] Section

This section controls the History Log functionality during runtime. Refer to the Framework Deployment Guide for more information about the History Log.

This section must be called history-log. This section is not created automatically; you must create it manually.

Important

If the Configuration Server configuration file contains legacy options history-log-xxx specified in its confserv section, they will be converted and copied into the history-log section when Configuration Server first starts up. After that, they will be ignored in favor of the new options in this section.

active

Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately

Turns the history log on and off. The value of this option can only be changed at runtime via the Configuration Server Application object properties. When Configuration Server is started, it automatically turns on the history log regardless of the previous setting of this option, and sets this option to true.

audit-expiration

Default Value: 365
Valid Values: Any positive integer
Changes Take Effect: Immediately

Specifies the number of days of records to retain in the database. For example, if the value is set to 30, the records of the last 30 days will be kept in the database and older records will be deleted. The maximum value for this option is 365. Configuration Server cleans up the history records based on this option every 30 minutes.

Important

The value of this option must always be greater than expiration.

audit-max-records

Default Value: 50000
Valid Values: Any positive integer
Changes Take Effect: Immediately

Specifies the maximum number of records that can be stored in the database. When the maximum number of records is reached, Master Configuration Server will delete the older records while adding new records. Genesys recommends not to set the value above 100000 for performance reasons. Configuration Server cleans up the history records based on this option every 30 minutes.

Important

The value of this option must always be greater than max-records.

client-expiration

Default Value: 1
Valid Values: 1–30
Changes Take Effect: Immediately

Specifies the maximum number of days the records of client sessions will be kept in the history log database before they are deleted. Also determines the time interval at which Configuration Server will check for expiration of records of both configuration updates and client sessions.

expiration

Default Value: 30
Valid Values: 1–30
Changes Take Effect: Immediately

Specifies the maximum number of days the records of configuration updates will be kept in the history log database before they are deleted.

write-former-value

Default Value: true
Valid Values: true, false
Changes Take Effect: Immediately

Specifies if old history values are stored for purposes of the configuration audit trail. If set to false, audit trail feature will be disabled.

Important

• Genesys recommends that you temporarily switch off this option if you are doing batch updates, such as tenant removal or switch removal, and are concerned about performance.
• Make sure you always back up your database before doing large updates.

max-records

Default Value: 1000
Valid Values: 1–1000
Changes Take Effect: Immediately

Specifies the maximum number of records Configuration Server will send to a client in response to a history log data request.