Skip to main content

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

Scheduling the case archival process

Updated on May 11, 2022

Control when your application archives cases to improve application performance and avoid issues that might negatively impact the performance of your Pega Platform.

Before you begin: Pega Platform cannot run a report on archived case data. Verify that you have run all the reports required on a case hierarchy before initiating an archival and purge process.

For more information about reports, see Running a report.

  1. In the navigation pane of Dev Studio, click RecordsSysAdminJob Scheduler.
  2. Select the pyPegaArchiver Job Scheduler.
  3. Copy the job scheduler to a ruleset in your application. For more information, see Creating a rule specialized by circumstance.
  4. Define the run cycle for the archiving process.
    1. On the Definition tab, select an option from the Schedule list to indicate how often the archiving process runs.
    2. Provide additional parameters based on the schedule type that you choose.
      For example, you can run the job scheduler every two months on the first Wednesday of the month when your schedule type is Monthly.
  5. In the Start time field, enter a time in hours and minutes.
    As a best practice, choose a time when there is less demand for case workers.
  6. In the Time zone list, select an option based on the location of your application.
  7. Click Save.
  8. Repeat this procedure for the pyPegaPurger and pyPegaIndexer Job Schedulers.
    1. Optional: Repeat this procedure for the pyArchival_ReIndexer property when you want to periodically schedule periodic fixes to corrupted indexes after a pyPegaIndexer job, and repeat it for the pyPegaExpunger when deleting archived case files permanently from Pega Cloud File Storage.
    For more information about the standard job schedulers, review the fields in the Documentation section of the History tab on the Job Scheduler form.

    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. is not optimized for Internet Explorer. For the optimal experience, please use:

    Close Deprecation Notice
    Contact us