Skip to main content

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

Reviewing archived case data

Updated on May 11, 2022

Search for archived cases to review data that is no longer in primary storage but is only in Pega Cloud File Storage, to confirm the success of archive processes, perform regulatory tasks for statutes such as HIPAA, or to search for previous business history.

Note: Archiving is supported by Theme Cosmos version 3 or later and Theme UI-Kit version 12 or later.

For more information on archiving in earlier versions of Theme Cosmos, see How to implement archival cases support.

Standard Case Management search capability

If you use an out-of-the-box Case Management search, find your archived cases in Pega Cloud File Storageby using the following procedure:

  1. In the Case Manager portal, search for an exposed property of the archived case that you want to review, for example, the case ID.

    Tip: To improve your search results, enter search terms that correspond to the values of exposed properties.
  2. In the list of results, in the Include menu, select Archived work items only.

    Cases with the Archived status are stored in Pega Cloud File Storage.
  3. Narrow the list of results by selecting filtering options in the Case menu, the Show menu, and the Last Updated menu.

  4. Open the case data in a read-only format by clicking a case name.

  5. Optional: To print your archived case data information, select RunPrint.
    Note: The full scope of your archive case data information is not available when in a printed format. Clients must customize their search functionality to meet their business requirements.
  6. Optional:

    To run a report on resolved cases before and after the archive process, compare the difference between the two reports to see the cases that Pega Platform both purged from the primary database and copied to Pega Cloud File Storage. For more information, see Running a report.

Using the Pega Platform-provided activity of pxRetrieveSearchData to search archived cases

If you cannot use the standard Case Manager Portal search, or it does not work due to client-specific customizations, query your archived case data in Pega Cloud File Storage (PCFS) by running the pxRetrieveSearchData activity.

  1. In the navigation pane of Dev Studio, clickRecordsTechnicalActivity.

    Alternatively, search for pxRetrieveSearchData.

  2. Select pxRetrieveSearchData.
  3. In the Actions list, select Run.

  4. In the Run Activity window, in the pySearchString parameter field, enter one of the following query formats:
    1. To search for all cases that you already archived, enter an asterisk (*).
    2. For specific cases, place an asterisk at both ends of the associated case number of the case you want to search. For example, *GC-11011*.
  5. In the pySearchAllRules list, select Yes.
  6. Optional: If you have archived a significant number of cases, enter the upper limit of returned results in the pyMaxResults field.
  7. In the pyReportClassName field, provide the class name for the case type.
  8. In the pyReportPageName field, enter pyWordIDSearch.
  9. In the pyIncludeAttachments list, select No.
  10. In the pySearchAttachmentsOnly list, select No.
  11. In the pySearchArchiveOnly list, select Yes.
  12. Click Run.
  13. In the resulting Clipboard, select pxSearchResults.pxResults pxResults, then select the case ID to review the archived case data.

    Reviewing archived case data in the clipboard

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