Skip to main content


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

Viewing case archiving statistics and log file entries

Updated on January 21, 2023

View details about the completion of tasks for jobs that run during case archiving processes using the Log-ArchivalSummary class or report definition. Review entries in the PegaRULES.log file for potential performance issues related to archival jobs.

Archival and expunge job statistics

When the archive and expunge processes run, Pega Platform saves statistics about each task that the jobs perform in the Log-ArchivalSummary class. View the summary class or run the report definition in Dev Studio to review the results of the archive and expunge jobs.

Note: The Log-ArchivalSummary class holds up to 365 days of entries. Entries older than this number are trimmed from display. For information about changing the number of days that entries are saved, see Trimming the Log-ArchivalSummary class.

The following table lists the details included in the LogArchivalSummary class and report definition:

Log-ArchivalSummary class and report definition details

DetailColumn titleDescription
Task namepyTaskNameThe step in the archive process for which the results apply.

  • Crawler – The step of the pyPegaArchiver job or the pzPerformArchive activity that confirms case eligibility for archiving.
  • Copier – The step of the pyPegaArchiver job or the pzPerformArchive activity that copies case data to the secondary storage.
  • Indexer – The pyPegaIndexer job or the pzPerformIndex activity that indexes case data for Elasticsearch in the secondary storage.
    Note: Because pyPegaIndexer only indexes cases, the number of cases processed (pyCasesProcessed) and the number of records processed (pyRecordsProcessed) should match.
  • Purger – The pyPegaPurger job or the pzPerformPurge activity that deletes copied and indexed case data from the Pega Platform database.
    Note: Because pyPegaPurger purges all copied cases and records, the number of cases processed (pyCasesProcessed)and the number of records processed (pyRecordsProcessed) should match.
  • Expunger - The pyPegaExpunger job or the pzPerformExpunge activity that permanently deletes archived case data from the secondary storage.
Task start time

Task end time

pyTaskStartTime

pyTaskEndTime

The time that the task started and the time that the task completed.
Case typeCase typeThe type of cases that the task processed.
Process durationpyDurationThe length of time that the task ran.
Number of succesful cases pyCasesProcessedThe number of cases that the task successfully completed.
Number of failed casespyCasesUnsuccessfulThe number of cases that the task failed to complete.
Number of succesful recordspyRecordsProcessedThe number of records that the task successfully processed for the cases, including custom associated data records.
Number of failed records pyRecordsUnsuccessfulThe number of records that the task failed to process for the cases.

Viewing the Log-ArchivalSummary class

View the Log-ArchivalSummary class for details about case archive and expunge jobs.

  1. In the navigation pane of Dev Studio, click App.
  2. On the Classes tab, in the Search field, enter Log-ArchivalSummary, and then select Log-ArchivalSummary from the options list.
  3. Click the Log-ArchivalSummary class.

Running the Log-ArchivalSummary report definition

Run the Log-ArchivalSummary report definition for details about case archive and expunge jobs.

  1. Open the Log-ArchivalSummary report definition:
    1. In the navigation pane of Dev Studio, click Records > Reports > Report definition.
    2. In the Applies To column, click the Filter icon, and then enter Log-ArchivalSummary in the Search Text field.
    3. Click Apply.
    4. Click the Log-ArchivalSummary report definition.
  2. In the Actions list, select Run.
    Result: The Log-ArchivalSummary report displays details about the case archive and expunge jobs.
  3. To edit the report and save the report in different formats, see Editing a report.

Trimming the Log-ArchivalSummary class

The Log-ArchivalSummary class holds 365 days worth of archived cases. Entries older than this number are trimmed from display. To change the number of days that the class holds entries, use the TrimLog activity.

  1. Open the TrimLog activity:
    1. In the navigation pane of Dev Studio, click Records > Technical > Activity.
    2. In the Activity Name column header, click the Filter icon, and then, in the Search Text field, enter TrimLog.
    3. Click Apply.
    4. Click the TrimLog activity.
  2. Select ActionsRun.
  3. In the daysAgo field, enter the number of days that you want to hold Log-ArchivalSummary class entries.
  4. Click Run.

Trimming exclusions from the Log-Archival Summary report

Pega Platform keeps cases on exclusion for a default of 365 days. Once a case has been excluded for 365 days, it becomes available for archival and purge. If you need to increase or decrease the time for keeping cases excluded from archival, change the number of days in dynamic system settings.Pega Platform trims the metadata table for cases that are excluded for 365. Then, they will be removed from the table even if the case is still excluded. To see that excluded case in the table, keep the data in the table.

Archival jobs log file entries

Review the PegaRULES.log file for entries about results of archiving jobs.

For more information about accessing log files, see Viewing logs.

  • To find log entries for the archival events, search for Archival-CaseCrawler, Archival-CaseCopier, Archival-Purger, or Archival-Indexer.
    • A maximum of five cases encountering an error are reported, even if more than five cases share the error. For example: 
      Added to copier queue. Processing completed for parent piInsKeyS: 
[<pzinskey for case #1>,
<pzinskey for case #2>,
<pzinskey for case #3>,
<pzinskey for case #4>,
<pzinskey for case #5>]
    • The log message Final status for file <filepath> is confirmation of completion of an archival job, with the file path of the corresponding .zip archive file in an external repository.
  • To find failures during your archival and purge process, search for the ERROR and INFO_FORCED log levels for archiving and purge jobs. Failures use the following format to present where the archiving and purge process did not succeed:

    <Log level> - <timestamp>
<Archival-CaseCrawler, Archival-CaseCopier, Archival-Purger, or Archival-Indexer job> : <CaseType>-<CaseTypeID>

Tags

Pega Platform 8.7 System Administration

Have a question? Get answers now.

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

Visit the Support Center

Did you find this content helpful?

Yes
No

Want to help us improve this content?
Suggest an edit

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