Skip to main content


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

Case report

Updated on November 22, 2021

Case report is a reusable and generic component for a process. Using case report, a manager or reviewer can consolidate data from a case and can generate a Microsoft Word or PDF document.

Pega Government Platform Implementation Guide Pega Government Platform Implementation Guide Pega Government Platform Implementation Guide Pega Government Platform Implementation Guide Pega Government Platform Implementation Guide Pega Government Platform Implementation Guide

You can add create report as a component from App Studio, and can generate a granular level report from case data. Pega Government Platform supports generating the details of case summary, interview, evidence, team members, assessments, and activity plans that are related to the case type. In addition to the above, the ICM application supports subjects as well.

Configuring case report in case designer

Configure the case report component in App Studio to use in a case type, as a step or an optional process, in a stage. You can use the case report component in case types that capture data related to interviews conducted, evidence, activity plans, and so on.

  1. Log in to Pega Government Platform as an administrator.
  2. In the header of your workspace, click the Switch Studio menu, and then click App Studio.
  3. In the navigation pane of App Studio, click Case types.
  4. In the Case types column, click a case type, or click the New button to create a new case type.
  5. In the Case life cycle section, click Stage, and then enter a name for the stage in the text box.
  6. Hover over Process, and then click STEPMoreProcessesCreate case report.
  7. Click the Select button.

Adding new data to the generated report

Create a case report with case details attached to the case type. The case report component is useful if the case type captures data related to interviews conducted, evidence, activity plans, and so on.

  1. In the Dev Studio Explorer panel, click App.
  2. Click the Classes tab, and in the Search box, enter PegaPS-Work.
  3. Click Data ModelData TransformPreDocumentGeneration.
    Note: If you are unable to view the PreDocumentGeneration data transform, click Show all results.
  4. Click the data transform to open it.
  5. Click the Save as button to save the data transform to the required class.
  6. In the Data Transform Record Configuration section, in the Label box, enter a title.
  7. In the Context section, select an application.
  8. In the Apply to area, enter or select the required class.
  9. In the Add to ruleset area, select a ruleset and the ruleset version.
  10. In the Current work item section,enter or select a work item to associate.
  11. Click the Create and open button.
  12. Click the Add a row icon to add a new data transform to which you want to add data.
  13. In the newly added data transform, in the Target box, enter or select the .DocumentationReportproperty.
  14. In the Source box, append the required content in HTML format.
  15. Click Save.

Adding a new selection item to the report contents for list objects

Add a new case type component to the case report. During the document creation, the case type component and its details appear.

  1. In the Dev Studio Explorer panel, click App.
  2. Click the Classes tab, and in the Search box, enter PegaPS-Work.
  3. Click User InterfaceSection Contents.
  4. Click the Save as button.
  5. In the Data Transform Record Configuration section, in the Label box, enter a title.
  6. In the Context section, select an application.
  7. In the Apply to area, enter or select a class.
  8. In the Add to ruleset area, select a ruleset and the ruleset version.
  9. In the Current work item section,enter or select a work item to associate.
  10. Click the Create and open button.
  11. Click the Add icon, and then click PickersCheckbox.
  12. Double-click the newly added check box.
  13. In the Cell Properties dialog box, enter the required details and then click Submit.
  14. Update the ShowItemsSelection (PegaPS-Work) When condition with the new property created above.
  15. Create a property in the PegaPS-Work class to hold the list of items for the user to select.
  16. Update the PreSelectItems (PegaPS-Work) data transform to set the details to list property.
  17. Update the SelectItems (PegaPS-Work) section to show the list of details for the user to select.
  18. Follow the steps mentioned in the Adding new data to the generated report section, to include the selected items in the generated report.

Using a Microsoft Word template

Create a new Word template while downloading the case report with details. The Word template helps in capturing key information and in maintaining consistency of the information.

  1. Click Create SysAdminWordTemplate.
  2. In the Word Template Record Configuration section, in the Label box, enter a title.
  3. In the Context section, select an application.
  4. In the Apply to area, enter or select a class.
  5. In the Add to ruleset area, select a ruleset and the ruleset version.
  6. In the Current work item section,enter or select a work item to associate.
  7. Click the Create and open button.
  8. In the Template section, click Upload file to upload the required Word template, and then click Save.
  9. In the Dev Studio Explorer panel, click App.
  10. Click the Classes tab, and in the Search box, enter PegaPS-Work.
  11. Click ProcessFlow Action Preview.
  12. Click Save as to save the flow action into the case where you need a new template.
  13. In the Flow Action Record Configuration section, in the Label box, enter a title.
  14. In the Context section, select an application.
  15. In the Apply to area, enter or select a class.
  16. In the Add to ruleset area, select a ruleset and the ruleset version.
  17. In the Current work item section,enter or select a work item to associate.
  18. Click the Create and open button.
  19. Click the Action tab.
  20. In the Apply data transform box, enter or select PostPreview.
  21. In the Post-processing section, in the Parameters area, enter the new template name and the class.
  22. Click Save.

Changing the PDF file styling

Change the styles in PDF document. The <style> tag defines the style information (CSS), where you mention how case details render in the PDF document.

When you generate a case report in the PDF file format, the DocumentationReport property which holds the complete markup stream of the PDF document, is passed as a parameter to the GenerateCaseReportDocuments activity through which the PDF document is generated.

The following is the styling CSS for PDF document in PGP and is set in step 4 of the PostPreview (CL:PegaPS-Work) data transform.

"<style> th{ align:justify; text-align: left; vertical-align: top; border-bottom: 1px solid black; } table{ border-collapse:collapse; } th,td{ padding:2px; font-size: 9pt; } td{ border-bottom: 1px dotted #000; font-weight:regular; text-align:top; vertical-align:top; } </style>"
  1. Save the PostPreview (CL:PegaPS-Work) data transform to the implementation layer.
  2. Update the new styling for the PDF document in step 4.

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