Skip to main content


         This documentation site is for previous versions. Visit our new documentation site for current releases.      
 

Configuring your data retention policy

Updated on January 20, 2023

Expunging case data from secondary storage on a regular schedule ensures compliance with your company's data retention policy and government policies, such as the General Data Protection Regulation (GDPR), and the Health Insurance Portability and Accountability Act (HIPAA).

Job Description
pyPegaExpungerThe pyPegaExpunger (default short description: Archival_Expunger) Job Scheduler permanently deletes archived files from an external repository and removes the data for the corresponding cases from the Elasticsearch index.

Track expunged cases

You can enable or disable logging of expunged cases in the Log-ExpungedCases report, after you enable the expunge process in Pega Platform.

The following table lists the setting details for tracking expunged cases.

Setting details
Setting namedataarchival/expungeEnableTracking
Owning rulesetPega-RULES
Best practiceTrack expunging of cases only if tracking them is a business requirement. Because the expunge process can remove hundreds of thousands of cases each time it runs, the Log-ExpungedCases report can grow rapidly.
Impacted deployment types

You can change this setting for the following deployment types:

  • Client-managed environments
  • Pega Cloud environments
Configuration typeThe setting is configured and displayed in dynamic system settings by default.
Value detailsType: Boolean (true or false)
  • true – Enable logging of expunged cases. Expunged cases are saved to the Log-ExpungedCases report for up to the number of days specified for the dataarchival/expungeEnableTracking setting.
  • false – Disable logging of expunged cases. Your application does not track expunged cases.
Related settings
System restart requirementSystem restart is not required. The newly assigned value is applied the next time the archive process runs.

Number of days to save expunged case entries

You can specify the number of days to save expunged cases in the Log-ExpungedCases report, after you enable the expunge process in Pega Platform.

The following table lists the setting details for tracking expunged cases.

Setting details
Setting namedataarchival/expungeKeepTrackedEntriesFor
Owning rulesetPega-RULES
Best practiceUse this setting to help you manage the size of the Log-ExpungedCases report. By limiting the number of days to save an expunged case record in this report, this setting can help you make sure that it does not become too large. Track expunging of cases only if tracking them is a business requirement. Because the expunge process can remove hundreds of thousands of cases each time it runs, the Log-ExpungedCases report can grow rapidly.
Impacted deployment types

You can change this setting for the following deployment types:

  • Client-managed environments
  • Pega Cloud environments
Configuration typeThe setting is configured and displayed in dynamic system settings by default.
Value details
  • Type: Integer (days)
  • Default: 7 days
Related settings
  • Dynamic system setting: dataarchival/expungeEnableTracking

    For more information, see Track expunged cases.

  • Archive setting: Permanently delete archived data
  • Archive setting: Permanently delete cases that are resolved earlier than (in days)

    For more information, see Archiving and expunging case data.

System restart requirementSystem restart is not required. The newly assigned value is applied the next time the archive process runs.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best.

Pega.com is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us