Skip to main content


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

Creating a screen flow

Updated on May 11, 2022

Create a screen flow to walk a single user through a series of screens to collect information. By dividing information into multiple screens, you provide a well-organized and user-friendly interface that is convenient to navigate.

For example, in an application to book medical appointments, you can create separate screens for patients to enter their personal details, their medical history, and a description of their current issue. As a result, the patient interacts with logically organized information.
Note: Creating a screen flow in Dev Studio provides for advanced configurations and is suitable for advanced developers. To create a form with multiple screens by using low-code tools, switch to App Studio and create a multi-step form. For more information, see Adding a multistep form to a stage.

Screen flow is a type of process. For more information, about processes, see Types of processes.

  1. Create the rule that stores the screen flow:
    1. In the header of Dev Studio, click CreateProcessFlow.
    2. In the Label field, describe briefly the purpose of the screen flow.
      For example: Enter Collect appointment booking info.
    3. Optional: To change the default identifier for the screen flow, click Edit, and then provide a unique value in the Identifier field.
    4. Click View additional configuration options, and then select Standard template for screen flows.
    5. In the Context section, select an application layer to store the screen flow.
    6. In the Apply to field, press the Down arrow key, and then select the class that defines the scope of the screen flow.
      The class controls which rules the screen flow can use, as well as which rules can call the screen flow.
    7. In the Add to ruleset field, select the name and version of the ruleset that stores the screen flow.
    8. Click Create and open.
    Result: A flow diagram with a new screen flow opens. By default, a new screen flow includes a Start shape, one Assignment shape, and an End shape, as shown in the following figure:
    Screen flow
    Flow diagram with a new screen flow that includes default flow shapes.
  2. Open a dialog box with screen flow configuration by double-clicking the Start shape.
  3. Optional: To provide a unique name for the Start shape, in the Start Shape field, enter a new value.
  4. In the Start section, define how an application displays the screen flow:
    ChoicesActions
    Apply a harness that you associate with a case typeIn the Harness list, select Use case type policy.
    Display navigation to screens as tabs
    1. In the Harness list, select Custom.
    2. In the Harness name field, press the Down arrow key, and select TabbedScreenFlow7.
      Result: At run time, an application displays assignments as horizontal tabs, as shown in the following figure:
      Tabs in a screen flow
      A run-time representation of assignments in a screen flow that an application displays as tabs.
    Display navigation to screens as a tree view
    1. In the Harness list, select Custom.
    2. In the Harness name field, press the Down arrow key, and select TreeNavigation7.
      Result: At run time, an application displays assignments in a screen flow as a vertical tree layout, as shown in the following figure:
      Tree layout of a screen flow
      A run-time representation of assignments in a screen flow that an application displays as a tree layout.
    Apply your custom harness
    1. In the Harness list, select Custom.
    2. In the Harness name field, press the Down arrow key, and select your custom harness.
    Note: At run time, an application displays every assignment in a screen flow as a separate screen.
  5. Optional: To save a case after the last step in a screen flow is complete, select the Save on last step checkbox.
    If you leave the Save on last step check box clear, the case saves information each time a user completes an assignment. As a best practice, save the case data on the last step to avoid performance issues.
  6. Optional: To allow users to move to the next assignments in a screen flow even if an assignment fails validation, select the Allow errors checkbox.
    Note: An option to allow errors is available only after you configure the screen flow to save a case on the last step.
    Result: Users can switch between screens even if the information that they provide fails validation. However, users can submit the flow screen only after an entire flow passes validation on the last step.
  7. In the Status section, in the Work status field, press the Down arrow key, and then select a status that a case obtains when the screen flow starts.
    For example: Select Open-InProgress.
  8. In the Routing section, in the Route to list, determine a user that completes the screen flow:
    • To assign the screen flow to a user who currently processes the case, select Current operator.
    • To assign the screen flow to another user in your application, select Operator, and then configure the user parameters.

      You can assign the screen flow to a user by user name or user reference, the reporting manager of the user who currently processes the case, or a case participant.

    • To assign the screen flow to a team that shares a work queue, select Work queue, and then select a team.

      A user who picks up the assignment from a work queue needs to complete an entire screen flow.

    • To assign the screen flow to a worklist or a team that shares a work queue, select Custom, and then in the Router field, enter a router activity to route the assignment.

      For example, you can route a screen flow to an external work queue.

    • To automatically determine a user at run time, select Use business logic, and then in the Decision tree field, enter a decision tree that returns a user to complete the screen flow.
    Note: For a screen flow, you define routing only once, when you configure the Start shape. Routing configuration is unavailable on other flow shapes in the screen flow.
  9. Optional: To define business requirements and instructions for the process, in the Specification section, associate a specification with your process:
    • To use an existing specification, in the Specification field, enter the specification.
    • To create a new specification, enter text in the rich text editor.
    • To use a .docx file that stores a specification, click Upload Word document as description, and then in the dialog box,select the file that you want to use.
    For more information, see Creating a specification.
  10. Click Submit.
  11. Click Save.
What to do next: Expand your screen flow with more flow shapes, and then integrate the screen flow with your case life cycle:
  1. Add shapes to the screen flow to define the different paths that the user can take. For more information about the different shapes that you can use, see Flow shapes.
  2. Mark the screen flow as a relevant record, so that you can reuse the flow across your application. For more information, see Marking a record as relevant.
  3. Add the screen flow to your case life cycle. For more information, see Adding a sequential process to a stage.

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