Flow form
Editing in Process Modeler — Creating and editing screen flows 

 About Flows
  1. About 
  2. New 
  3. Diagram 
  4. Parameters 
  5. Pages & Classes 
  6. Design 
  1. Process 
  2. Specifications 
  3. Requirements 
  4. Test Cases 
  5. History 
  6. More... 

A flow that presents a user with a sequence of forms to complete is known as a screen flow. This specialized type of flows provides an effective way to simplify input processing and present questions or input fields in a series of related forms. Users can change an answer to an earlier question by backing up in the flow; and, in some situations, can complete steps in any order.

For a configuration example, see PDN article How to create a screen flow.

Task shapes allowed

To support this style of interaction, a screen flow's Process Modeler diagram can contain only these shapes:

Assignment Start
Decision End
Subprocess Split For Each
Utility Annotation

Because many business processes require additional shapes, you may need to create a subprocess for the screen flow iterations, and call the subprocess from an unrestricted starter flow.

Procedure

Follow these steps to create a screen flow:

  1. Create a new flow by doing any of the following:

    The Flow: New dialog appears.

  2. In the New form, click the View additional configuration options link.
  3. Select ScreenFlow as the Template value.
  4. Enter the other required information in the form.
  5. Click  Create and open to open the record (it has not been saved ).
  6. If you want a tabbed screen flow, open the Start shape property panel. In the Harness field, enter TabbedScreenFlow.
  7. Make sure the Entry point check box on at least one assignment task, subprocess task, or utility task in the flow is selected. At runtime, entry points control to which places in the flow the users can jump.
  8. Save the record.
  • If this is a subprocess, open the flow that creates the work item and then calls or branches to the screen flow you created. Add a Subprocess shape . Specify Screen Flow as the in the Filter Flow Rule By field in the Flow Rule field specify the screen flow you created. Save the calling flow.

    • Completing the Start Properties panel

    Optionally, enter a name to the right of the Start Shape heading. The system automatically enters this name in the Specification area. You can edit the name, which appears below the shape on the diagram.

    Start

    Complete these fields:

    Field

    Description
    Harness

    SmartPromptSelect one of three standard harnesses that support screen flows, or a custom harness you have evolved on one of these three:

    Work-.TabbedScreenFlow To present the screen flow steps as horizontal tabs. If the first screen flow calls a subprocess screen flow, a second level of tabs appears for the subprocess entry points.
    Work-.TreeNavigation To present the screen flow steps in a tree structure.
    Work-.PerformScreenFlow To present the screen flow steps as rectangles in a breadcrumbs display rather than as clickable tabs.

    For an example of the tabbed approach in use, select Pega button> Process & Rules > Tools> Find Rules> Find by Custom Field. This wizard uses the standard rule PegaAccel-Task-Wizard.CustomFieldsWizard.

    Note The standard V6.2 screen flow harnesses do not use the EndUserV62 styles, which are applied to the standard V6.2 case manager portal and user harnesses. To apply these styles to screen flows, you must specify the standard CSS text file pyScreenFlow_EndUser62 in the Harness rule forms. See Harness Forms — Completing the Scripts and Styles tab.

    Tabbed screen flow

    Supporting more than two levels of tabs

    Advanced featureA second row of tabs appears when a user executes a subprocess screen flow (that has entry points) that is called by a first-level screen flow. The standard final HTML rule Work-.NestedTabbedNavigation defines this limit. To support three or more levels:

       1. Copy this rule into your application with a work class as the Applies To key part, keeping the second key part.

       2. Update one line in the HTML Source field to specify the number of sublevels desired. For example enter 2 to support three levels of tabs.

    tools.putParamValue("Levels", nnn);

    3. Optionally, update one line in the HTML Source field to specify the name of styles for each sublevel, separated by commas:

    tools.putParamValue("ChildNodeStyle", "style1",
    "style2", );.

    4. Save the HTML rule form.
    Save On Last Step

    Check this check box to cause the work item and work item history to be committed only once, after users complete the entire screen flow. Clear the Save On Last Step check box to let users select a Save local flow action at each point in the flow. After a Save local action, users can continue processing this flow, perform other work, or log off.

    TipAs a best practice, select the Save On Last Step box in most cases, to reduce the number of work item Commit operations and history instances.

    Allow errors?

    This field appears if the Save On Last Step check box is checked.

    Select to allow users to select another entry point when executing a screen flow or a flow that is not a screen flow that includes breadcrumbs control, even when the form (or tab) for the current entry point reflects validation errors. (The user must eventually clear all such errors.)

    If this option is not selected, users can advance to the next step of a screen flow, or click the breadcrumbs control, only after data in the current tab is valid.

    TipTo prevent users from completing information that's never used, don't select the Allow errors? check box if the values in any entry point (for example, an Assignment task) directly or indirectly affect the outcome of a later Decision shape.
    Application

    SmartPromptOptional. Select the name of the application that you want to link to the shape. The value of this field is referenced with the flow diagram in application documents.
    Work Type

    SmartPromptOptional. Select the name of the work type for the application that you want to link to the shape. The value of this field is referenced with the flow diagram in application documents.

    Routing

    Complete the Routing section to select the router activity available at runtime.

    Field

    Description
    Router

    SmartPromptOptional. You can select a router activity here. At runtime, a single user processes all assignments in a screen flow. Identify the routing applied to all these assignments. Select ToWorklist to route the assignments to the current user.

    You cannot route a screenflow assignment to a workbasket.

    Parameters

    The router activity you select may accept input parameters. Supply a value for each parameter. PRPC validates these parameter values when you Save (unless the flow in is Draft mode).

    Specification

    Field

    Description
    Specification

    Enter a name to associate a specification with this shape. If you entered a shape name, the system enters the name in this field. You can either:

    • Choose an existing specification by selecting Choose another specification from the Specification Actions menu.
    • Create a new specification by entering a name (or keeping the name entered by the system).

    Enter a description in the text area beneath the specification name. When you click OK on the Properties dialog, the system creates or updates the specification. See Working with specifications in Process Modeler and Case Designer.

    Status

    Field

    Description
    Work status

    Enter a work status in this field to set the status for the work item. This allows you to easily change the status at multiple points in the life cycle of a work item without adding a Utility shape to the flow for each status change. Similar to setting work item status using a Utility shape, setting the status invokes the UpdateStatus activity. Any defined tickets dependent on the status are raised, as appropriate. The selected status updates .pyStatusWork when the flow execution reaches this assignment shape.

    A status indicator appears on connectors to shapes that change a work item status. For example, if the shape status is set to Pending-External, the connector to that shape displays a small red flag. All transitions connecting to the shape will display the status indicator. Following are the status indicators for the four status prefixes.

    New

    Open

    Pending

    Resolved

    Completing the Assignment shape panel

    Optionally, enter a name to the right of the Assignment heading.

    Each Assignment shape has only one connector flow action. Complete these Assignment Properties panels for each screen:

    Field

    Description
    Name

    Enter the name of the assignment as it appears on the Process Modeler diagram and on the rectangle or tab at runtime.
    Instructions

    Select a field value rule for the worklist display that describes the task that users perform to complete the assignment. Click( magnifying glass) to review the field value rule or define a new field value rule. The SmartPrompt lists field value rules with an Applies To key part equal to the work type of the flow (or a parent class) and a Field Name key part of pyInstructions.

    NoteWhen you plan to localize the application using this rule, so the application can support users in various languages or locales, choose the text carefully and limit text length to 64 characters. A field value rule with this text as the final key part is needed for each locale. When practical, choose a caption already included in a language pack, to simplify later localization. See About the Localization wizard.
    Flow Action

    Identify one connector flow action.
    Application

    Optional. Select the name of the application that you want to link to this shape. The value of this field is referenced with the flow diagram in application documents.
    Work Type

    Optional. Select the name of the work type for the application that you want to link to this shape. The value of this field is referenced with the flow diagram in application documents.
    Specification

    Optional. Select the name of the specification for the application and work type that details the implementation requirements for this shape. The value of this field is referenced with the flow diagram in application documents and on the Implementation tab of the corresponding Application Specification.
    Entry Point

    Select to create an entry point for the assignment and allow user processing at runtime to begin or resume at this point in the flow. When selected, if this screen flow presents steps as tabs, at runtime a tab appears with the Name value as a label.

    Leave cleared to indicate that users cannot return directly to this assignment; users may be able in some cases to reach it indirectly from an earlier assignment.
    Only going back?

    This check box appears only when you select the Entry Point? check box. Select to restrict users at runtime from jumping ahead to this step without having completed the preceding steps. After having completed this step, users may jump back to it from steps that follow it.

    TipFor maximum user flexibility, leave this check box cleared if your flow accepts inputs in any order. However, this approach is typically not workable for flows that contain fork and decision shapes, or that have intermediate tasks that are not entry points.
    Post Action on Click Away?

    Select to cause PRPC to execute the Validate Rule rule and the After This Action... Run Activity activity (both on the Action tab of the Flow Action form) when a user at runtime clicks a screen flow tab or screen flow tree node to leave this assignment and start (or return to) a different assignment. The post-processing activity can compute additional property values and perform other processing.

    If the option is not selected, the validate rule does not execute and the post-processing activity does not execute when the user clicks to leave the assignment. 5 GRP-402 PROJ-1350

    TipAs a best practice, check this option if the action has a non-blank Validate Rule or non-blank After This Action... Run Activity activity.

    Specification

    Field

    Description
    Specification Enter a specification name to associate a specification with this shape. You can either select an existing specification by selecting Choose another specification from the Specification Actions menu, or by entering text in the field to create a new specification. Enter a description in the text area beneath the specification name. When you click OK in the Assignment Properties dialog, the system creates or updates the specification. See Working with specifications in Process Modeler and Case Designer.

    Status

    Field

    Description
    Work status

    Enter a work status in this field to set the status for the work item. This allows you to easily change the status at multiple points in the life cycle of a work item without adding a Utility shape to the flow for each status change. Similar to setting work item status using a Utility shape, setting the status invokes the UpdateStatus activity. Any defined tickets dependent on the status are raised, as appropriate. The selected status updates .pyStatusWork when the flow execution reaches this assignment shape.

    A status indicator appears on connectors to shapes that change a work item status. For example, if the shape status is set to Pending-External, the connector to that shape displays a small red flag. All transitions connecting to the shape will display the status indicator. Following are the status indicators for the four status prefixes.

    New

    Open

    Pending

    Resolved

    Completing connectors

    Only one connector must start from each Screen shape. Because this connector is always followed during a flow execution, no additional information is needed in a properties panel.

    Call or branch to subprocess

    A screen flow can call or branch to another flow, but only if the other flow is also a screen flow and uses the same harness.

    Decision shapes

    No restrictions apply to Decision shapes used in a screen flow. Such tasks are normally not entry points. From a Decision shape, two or more connectors are required.

    Split For Each shapes

    When using a Split For Each shape in a screen flow, the only flow processing mode is Iterate, which spawns flows for elements of a Page Group or Page List property. No when conditions are available. Page Group properties are processed unordered and all pages are shown.

    Buttons for Back, Next, Submit, and Cancel

    At runtime, each assignment task in a screen flow presents a button labeled  Next>>  . When users click this button, processing validates user input and advances to the next assignment. (For tabbed screen flows and tree screen flows, the label on the  Next>>   button changes automatically to  Submit   when this assignment is the last one in a flow.)

    A  <<Back   button appears automatically when a user has completed any task that is an entry point.

    Optionally, screens can also include a  Cancel   button. To include a  Cancel   button:

    1. Update the Parameters tab of the screen flow to add a flow parameter named bAddCancel. Select Boolean as the Data Type.
    2. Open each calling flow. Locate the Flow shape that calls the screen flow subprocess. On the Subprocess Properties panel:
    3. Add a ticket named Withdraw at an appropriate place in the calling flow. When a user clicks the  Cancel   button during execution of the screen flow, a ticket named Withdraw is activated. Processing typically continues at that ticket task in the calling flow execution.

    Examples

    The standard flow PegaSample-CustomerRequest.CustomerFeedback is a screen flow. This subprocess is called by the NewWork starter flow when all members of the cover are resolved.

    The standard flow PegaAccel-Task-Harvest.GatherRuleInfo is a tabbed screen flow that supports user cancellation. This subprocess is called by the PegaAccel-Task-Harvest.HarvestRule flow, which supports the rule harvest facility.

    Notes

    Four standard rules support execution of screen flows:

    Definitionsscreen flow, subprocess
    Related topicsFlows — Editing the Call or Branch to Subprocess shape properties
    Flows — Editing the Decision task shape properties
    Flows — Editing the Split For Each shape properties

    UpAbout Flows

    Open topic with navigation