Close popover

Table of Contents

How to create correspondence rules


Use correspondence rules to assemble your correspondence pieces into correspondence templates. If you need to organize your correspondence pieces by work class, use correspondence rules as though they were fragments and then include them in a top-level correspondence rule.

For more information about correspondence rules, see the Correspondence Fragment and Correspondence Rules section in "Overview of the Correspondence Feature."

Update: This article is for V5.2. For V5.5+, see How to define correspondence using the rich text editor.

Suggested Approach

To create correspondence rules, complete the following steps:

  1. From the Rules by Type explorer, select Process > Correspondence.
  2. From the list, click New.

    Note: You can also create new correspondence rules by clicking the pencil button next to the CorrName input parameter in a flow shape.

  3. In the New dialog box, specify the Applies To class of the rule (most likely either the work class or the class group), enter a name in the Corr Name field, select a correspondence type, and specify the appropriate RuleSet and version.
  4. Click Create.
  5. On the Corrtab of the rule, enter the appropriate text, HTML formatting, and logic. For example:


    For information about typical JavaServer Pages tags used in correspondence, see the Common JSP tags for correspondence section in "Correspondence Reference." For information about the entire JSP tag library, see the Application Developer Help.

    Note: Be sure to use HTML character entities for special characters — & for ampersand, for example. Also, do not copy and paste text from Word documents unless you have limited it to an ASCII font like FixedSys.
  6. Optional. If this rule will be selected by operators at runtime, scroll to the bottom of the Corrtab, click in the User Edit field and specify whether they can preview and/or edit the generated results:


  7. If operators can preview the results generated from the rule at runtime, determine whether the default settings for Display Width and Display Height are correct for your design. These fields determine the size of the area that displays the generated correspondence rule to operators.
  8. Specify whether extra spaces should be removed from the generated results.
  9. In the Generate For field, select JSP.
  10. In the After Create field, specify whether the correspondence can be sent right away or whether it needs to be verified first.

    Note: If you configure the correspondence rule to require verification, ensure that your flows respond appropriately if generated correspondence is rejected. For example, can the work object be resolved if the generated correspondence was rejected? If not, create a path in the flow that handles rejected correspondence.

  11. If this rule is a top-level template that you want to be able to select from flow shapes or for operators to be able to select at runtime, click the Promptstab and select the Top-Level Correspondence Rule option:


  12. Click Save.
  13. Optional. Click the Preview toolbar tool to see the results that will be generated from the rule.

Limiting the List of Displayed Rules

If there are many top-level correspondence rules that operators can select, consider using privilege rules to limit the number of rules that are displayed for them. Additionally, if you have correspondence rules that generate sensitive material and should only be displayed to a certain subset of operators, use a privilege rule to limit access to those rules.

You create or identify a privilege rule and then specify it on the Security tab of the correspondence rule. Then, only those operators who have that privilege will be able to select the rule.

For information about creating privilege rules, see the Application Developer Help.

Pega Platform 7.1.1 - 8.3.1 Business Architect System Architect Case Management
Suggest Edit

100% found this useful

Have a question? Get answers now.

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