Purge work items

You can manage processed work items by enabling a setting to purge the work items. Based on this setting, you can purge (delete) unwanted files, work items, exported zip files, and so on automatically. Thus, it reduces your efforts to manually delete the items.

Prerequisites

  • Ensure that you log in as administrator to the Control Room.
  • Ensure that you have View Settings and Manage All Queues permissions to view the auto-purge setting.
  • Ensure that you have Manage Settings and Manage All Queues permissions to edit the auto-purge setting.

Considerations when purging work items

Consider the following points when you define the auto-purge setting:
  • The time frame to auto-purge work items must be the number of days.
  • The time frame (number of days) range is 1 to 90. It cannot be 0 or a negative number.
  • The default time frame is 7.
  • The completed work items will be deleted automatically after 30 days.
  • You can purge work items in all queues, that is queues in Not in use, Active, and Paused status.
  • When you delete a queue that is getting purged, you encounter an error message.
  • If the Control Room is updated while purging is in progress, then the purging might fail. The work items will be purged in the next purging process.
  • When auto-purge setting is enabled, the Work items tab for queues in edit and view mode shows a message that informs days after which the completed work items will be deleted. For example, Completed work items older than 30 days will be automatically purged.
  • If you manually mark work items as Completed, then these work items do not have start and end time. Therefore, such work items will not be purged. You must delete them manually.

With this functionality, you can set the time frame in days. Based on the set number of days, the successful items are deleted automatically.

Procedure

  1. Navigate to Administration > Settings > Workload Management and click Edit.
    By default, the auto-purge setting is disabled.
  2. Click Edit.
  3. Use the toggle to select On.
  4. Use the days field to enter the number of days after which you want to delete the work items.
  5. Click Save changes .
    The completed work items are automatically deleted that are older than the defined number of days.
    Note: When this setting is enabled, you cannot purge work items that are in the Data error, New, Ready to run, On hold, Active, Failed, or Unknown status.