Configuring Access History

The Access History Configuration page is available under Global Settings for users with the appropriate rights, Access History Admin. The page allows you to edit and save the decided options.

Navigate to the gear > Global Settings > Access History Configuration page, which includes Access History Controls.
Make sure the Enable Access History checkbox is selected.
Enter a Destination Queue Name.

See Working with the Data Extract Message Broker for more information about message brokers and queues.
Select Save Changes or Cancel.

Additional configuration may be completed in the Debug page, where the following objects are available:

Configuration object "SystemConfiguration"
- accessHistoryEnabled
  
  Set to True to enable Access History.

Configuration "AccessHistoryConfiguration"
- jsonFormat
  
  If set to PRETTY, JSON strings are stored in an easy-to-read format.
  
  If set to MINIFIED, JSON strings are stored in unformatted JSON with white space removed.
  
  If set to ZIPPED (default), JSON strings are compressed.
  
  Note: Due to space considerations, it is advisable to leave jsonFormat set to ZIPPED, unless suggested by support for troubleshooting.
- maxAllowedPatches
  
  A patch capture only captures the differences from the previous capture of the object. It is useful for saving space.
  
  If maxAllowedPatches > 0, patch document support is enabled. This property identifies the number of patch documents that can be saved between full captures, e.g., if the value is 2, every third capture will be a full capture. This pattern can change based on the config property captureMaxAgeInDays.
- captureMaxAgeInDays
  
  If a patch document is older (in days) than the number specified in captureMaxAge, a full capture will be taken regardless of the number of patch documents.

A default Extract YAMLConfig is available for Access History. If you prefer to create a custom configuration, see Configuring Data Extraction.


	You are here: