Skip to content

Retention Backup

In case backup was enabled at the system level (see Backup Elasticsearch Configuration), snapshots of activity indices will be taken for any application that has Activity Data Retention configured.

The snapshot will contain all the indices that should be deleted and will be created before the retention deletion process takes place. The snapshot repository and format are described in the Elasticsearch Backup Overview.

To enable retention backup, complete the following steps:

  1. In the Server Installer, select the Use Elasticsearch Backup option.
  2. When setting up an application, on the Activity Configurations and DECs screen, enable Clear Activity Data and Backup Events Before Clearing.
  3. Provide the time frame for keeping the backup data.
  4. Within the Tasks screen, initiate the Activity Data Retention Cleanup task.

Running this task will:

  • Mark indices for deletion for each configured application.
  • Back indices to the "retention_backup" folder.
  • Delete the backup indices.