Configure the retention policy

Configure the retention policy to remove the artefacts and automatically assist in minimizing the database size.

  1. Navigate to System > System settings > Database, retention and reporting > Retention policy.
    The Retention policy dialog box is displayed.
  2. By default, the Version tab is open and all versions are retained for an item (Forms, Processes, Business rules, Classification groups and Extraction groups). To configure the number of versions you want to retain for an item, under Version based retention, select Custom and select the number of versions, such as Last 8 Versions - the latest eight versions of the selected item are retained. (Default: Last 10 Versions, Minimum: Last 1 Version.)
  3. By default, an item is retained permanently. To configure the time-based retention period for Internal users, External users, Audit log entries, and KCM packs:
    1. Click the Time tab.
    2. Under Time based retention, select Custom for the item, such as KCM packs and then select the number of years, months, and days. (Default: 1 Year, 0 Months, 0 Days, and Minimum: 1 Day)
  4. By default, all the documents are retained indefinitely. To configure the custom retention period:
    1. Click the Document tab.
    2. Select Custom for Retain documents and then select the number of years, months, and days. (Default: 1 Year, 0 Months, 0 Days, and Minimum: 1 Day)
    3. To define retention period for a specific document type, under Specific document type retention, click .
      The Add document type retention policy pop-up appears.
    4. On the Document type list, select a document type.
    5. Click Custom and then select the number of years, months, and days. (Default: 1 Year, 0 Months, 0 Days, and Minimum: 1 Day)
    6. Set the retention mode for the document type From either of the following:
      • Date document last accessed: The document type is retained based on the date the document was last accessed.

      • Date document marked as finished: The document type is retained based on the date the document is marked as finished.

        Ensure that documents are marked as finished if retention mode for that document type is based on "Finished at" timestamp. If documents that are configured "Finished at" based retention policy were not marked as finished. then the documents will not be picked up by retention policy and will not be deleted from the database.
  5. To define the retention process execution:
    1. Click the Execution tab.
    2. Under Retention process execution, select the Retention chunk size (default: 250) and Maximum jobs that can be deleted per retention task execution. (Default: 250 for documents and 1000 for jobs).
  6. Click Save.

    The configured settings are saved.