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.

Understanding the Case Management Gallery sample application

Updated on September 10, 2021


The Case Management Gallery includes an example of an application that demonstrates many of case management features and capabilities. This article shows you how to:

  • Examine the case management structure, processes, and user interface components.
  • Modify the process settings to explore alternative scenarios and extend the applications initial configuration.
  • Use the rules in the sample as templates for creating and building your own application.

Suggested Approach

Access the Gallery by selecting Pega button > Process & Rules > Case Management > Gallery. The navigation tree in the left panel presents a sample application case type hierarchy. It contains three case types:

  • Support Request (Parent) — PegaSample-SupportRequest
  • Repair (Subcase) — PegaSample-Repair
  • Warranty Investigation (Subcase) — PegaSample-Investigation

Application summary

The application user intakes requests from customers who need to have a product repaired. In a series of three screenflows, the user inputs the customer's information, the product (s), and a description of the problem. When the user submits the form, the system creates a Support Request case, and automatically creates Warranty Investigation and Repair subcases for each product.

Ordinarily, a user begins the Warranty Investigation process first. The Repair case waits in a workbasket until the Investigation subcase resolves. In special situations, the user can choose not to wait and manually begin the Repair subcase.

During the investigation process, the user indicates whether the product is under warranty. If yes, the Repair subcase advances to a Complete Repair assignment when the Investigation is resolved. If no, the subcase advances to a Notify Customer assignment.

When both subcases are resolved, the parent Support Request case is resolved.

Note: For the purpose of this article, one user handles all of the cases.


To create a Support Request, do the following:

  1. On the tree in the left panel, select Support Request.
  2. On the right panel, click the Run arrow () next to the Start Support Request starting process.
    The Perform user form opens.
  3. On the first screen, select a customer from the list and click Next.
  4. On the second screen, select a product and click Next.
  5. On the third screen, select a product and click Finish.

    The system creates a Support Request case (C-51) and opens its Review form. In addition, Two subcases, Warranty Investigation (C-52) and Repair for Black Widget (C-53), have been automatically created and are identified in the Case Contents section.
    Note the subcase statuses — Warranty Investigation is ready for the user to start (New), while Repair is assigned to a workbasket and waiting for Investigation to complete (Pending).
  6. Before beginning work on the Warranty Investigation subcase, click Waiting for Investigation Case to Complete to open its Perform user form.

    The message states that this subcase is waiting for the Investigation subcase to complete. The user can, however, can bypass this dependency and create the Repair subcase manually by clicking  Start Repair  .
  7. Click the Sample Support Request (C-51) link in the top left corner to return to the Support Request Review form.
  8. On the list beneath Warranty Investigation (C-52) case, click Complete Investigation of Issue. Its Perform form opens.
  9. Select the Yes radio button for Is this Product under Warranty?
  10. Enter a warranty expiration date, and a note.
  11. Click Submit to resolve the subcase.
  12. At the top of the Warranty Investigation Review form, click the Sample Support Request (C-51) link to return to the case's Review form.
  13. In the Case Contents area, note that the warranty Investigation subcase is resolved and the Complete Repair subcase is Open (updated from Pending-Investigation).
  14. Click click Complete Repair..
  15. In the Perform form, enter the Repair Notes information and click Submit to resolve the subcase.
    Support Request C-51 and its subcases (C-52 and C-53) are resolved.
  16. To see what happens when a product is not under warranty, create a new Support Request case. In the Warranty Investigation process, select No next to Is this Product under Warranty? in the Complete Investigation form.
  17. Click Submit to resolve the subcase, and return to the parent's Review harness. The Notify Customer assignment appears on the case list.
  18. Open the assignment and resolve it to resolve the parent case.

How subcases are created

You use instantiation settings in parent case type rules and dependent assignment shapes in subcase processes to define how subcases are created (instantiated). Return to the Gallery to explore how this application creates subcases.

Instantiation dependency 

A subcase is created when its parent case is created, either automatically by the system, or manually by the user.

To see how the Warranty Investigation subcase is automatically created, select Support Request (Parent case) in the left panel. On the right panel, click the (Open) link next to the case type name to open the Case Type rule form.

The Coverable Work Types area defines which case types are covered (subcase types), and how their subcases can be created.

The system automatically creates (Automatic Instantiation) an Investigation subcase when the user creates a Support Request case. The user has the option of manually creating (Manual Instantiation) another subcase from the Other Actions list on the Perform user form.

The user can also manually create a Repair subcase as defined in the PegaSample-Repairarray on the parent case type rule.

Mid-process dependency

A dependent subcase is created and waits in a workbasket when a subcase in another case type is created. When the "dependent on" subcase reaches a specified work status, the system automatically advances the dependent subcase's process. You use a Dependent-type Assignment shape in that process to configure the dependency conditions.

To see the mid-process dependency defined for the Repair case type, do the following:

  1. On the left panel, select Repair.
  2. On the right panel, select the Starting Process Repair link to open its flow.
  3. Double-click the Wait for Investigation to Complete Assignment shape to open its Properties panel.
    The settings in this Dependency-type assignment specify that a Repair subcase must wait for an Warranty Investigation subcase to reach a work status of Resolved-Completed before it can advance on the pyStartRepair connector flow action.

Using configuration settings

You can alter some user form elements or process behaviors using settings in the Gallery's right panel, which corresponds to the Details tab on your application's Case Designer.

To make updates:

  1. On the left panel, select the case type you want to update.
  2. On the right panel, click the (Edit) link next to the setting.
  3. Make your changes in the pop-up dialog.
  4. Click OK to save your changes and close the dialog .
  5. Click the refresh icon ( ) on the tab bar to update the settings on the panel.

Before you begin, make sure you have an unlocked RuleSet version in your application. Most of the settings are referenced by underlying rules. When you first update a setting value, the system automatically creates an updated copy of the rule to your RuleSet version in the case type's Applies To class. Subsequent edits update the copy. For instance:

  • Starting Process, Supporting Processes, Stages, Calculations, Data Propagation, Instantiation,and Validation creates a copy of the case type rule.
  • Goals and Deadlines creates a copy of the pyCaseTypeDefault service level rule.
  • Parties creates a copy of the pyCaseManagementDefault work parties rule.

The following describes the Appearance, Stages, and Instantiation settings.


Each subcase has a unique image that identifies it on the case list. You can customize the image by clicking the Appearance item on the panel. In the Appearance icon dialog, select an icon to replace the current one.


In the Case Status tab at the bottom of the form, there is a work status-based horizontal array of read-only chevron images. They provide users with a high-level view of the individual tasks that must be performed in order to resolve the case.

Configure the array using the Stages item on the panel:


This setting appears only for parent case types, and reflects the values in the Coverable Work Types area on a Case Type rule form (described above in How subcases are created). As best practice, use this setting, not the case type rule, to make your updates.

Explore the other settings on the panel.

Customizing the processes

To modify a sample process, open the flow rule in the right panel by clicking the Starting Process link. Save the flow to a RuleSet in your application. Keep the Applies To and Flow Name key parts so that you can access and start the process from the Gallery. You can always return to the default flow by deleting your copy.

Examining the user interface

To examine user interface components such as harnesses, sections, flow actions, and controls use the Rules Inspector tool. In the Designer Studio Quick Launch bar, select   > Rules Inspector > HTML Rules. Click the icons to open the rules.

Additional information

When and how to use instantiation dependencies

When and how to use mid-process dependencies

Introduction to the Case Designer


System Architect Lead System Architect Business Architect Experience Designer Pega Delivery Leader System/Cloud Ops Administrator Case Management Financial Services Healthcare and Life Sciences Insurance Communications and Media Government Healthcare and Life Sciences Consumer Services

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