Skip to main content

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

This content has been archived and is no longer being updated.

Links may not function; however, this content may be relevant to outdated versions of the product.

Generating case documents

Updated on November 22, 2021

To provide your stakeholders with crucial information about your business processes in an automated and convenient way, generate case documents as part of your case life cycle. You create case documents by using templates to ensure that you deliver relevant, required data.

When you create templates for your case documents, you include tags that your application populates with case data during case processing. You can include tags for the following entities:
  • Fields that a case data model contains
  • Attachments
  • Views
  • Correspondence
For example, you can add tags for the case ID, goal and deadline, or case participants. You can also reuse one template for different cases, because every time your application provides information that is specific to the current case. You create document templates in a text editor and save files in the .docx format.
Before you begin:
  1. In the navigation pane of App Studio, click Case types, and then click the case type that you want to open.
  2. In a process to which you want to add a Generate document shape, click StepMoreAutomationsGenerate document.
  3. In the Step properties panel, select a document to use as a template:
    Create a new template
    1. Create a new document in a .docx format in a word processor.
      The case document that your application generates reflects the styling that you use when you create a template, for example, the font and size.
    2. In the Step properties panel, click View and use fields.
    3. In the View and use fields window, search for a tag that you want to include in your document, and then click Copy tag.
    4. Paste the tag where you want to include information in your document.
    5. Repeat steps 3.c and 3.d for the tags that you need, and then save the document.
    6. In the Choose template document section, click Upload.
    7. In the Upload file window, click Choose file, and then navigate to the text template.
    8. Click Open.
    9. Click Done.
    Use an existing template
    1. In the Choose template document list, select a template that you want to use.
  4. In the Document name field, enter a descriptive name for the output document.
    For example: Name your document Job offer.
  5. In the Category list, select a category for your document.
  6. Click Save.
Result: At run time, when your application generates a case document, users can open and download it in the Recent content section.
  • Case documents tags

    Customize your case documents by configuring the tags that you include in your case document templates. For example, if your case includes financial information, you can include tags for the currency.

  • Case documents specifications

    Ensure that your application generates the necessary documents in a case life cycle by learning more about the specifications of the elements that you can include in your case documents. You can then save time by generating documents that do not display error messages, and understand how you can achieve your business goals by including relevant business data in the output documents.

  • Case documents error messages

    Resolve any issues when you generate case documents by understanding the error messages. Inline error messages that an output document displays might help you locate and fix the issue.

  • Activities for integrating cases with Excel documents

    To integrate case data with external resources, call the pxParseExcelFile and pxGenerateExcelFile activities that Pega Platform provides. By calling these activities, you can import and export case data by using Excel files.

  • Tags for generating .docx documents through APIs

    APIs support generating formatted and personalized documents that you can use during case processing. To save time and resources, the pxGenerateWordDocument API provides the possibility of generating a .docx document on the server side, without installing additional software, such as Silverlight.

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