Flow form
Editing the Call or Branch to a Subflow shape properties

Field

Description

Assign a name to the shape. . Choose a name meaningful to application users who see this on the work object history display, the breadcrumbs control (for entry points), and the Where-Am-I? diagram. It does not affect flow execution.

When first building, it is simplest to make this name the same as the name of the called flow. Later when your flow is complete, you can change the name to be more descriptive.

Identify the objects the flow rule is to update. Select:

• On Current Work Item to continue processing on the current (unresolved) work object in the next flow.
• Choose On Another Work Item to start processing on a different work object.
• Choose On Embedded Page when this flow is part of a Split-forEach operation.

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

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

Optional. Select the name of the use case for the application and work type that details the implementation requirements for the flow shape. The value of this field is referenced with the flow diagram in application documents and on the Implementation tab of the corresponding Rule-Application-UseCase instance.

Field

Description

Assign a name to the new flow, an arbitrary text string containing no spaces. This name appears in the Visio diagram and in your flow form.

When first building, it is simplest to make this name the same as the name of your flow. Later when your flow is complete, you can change the name to be more descriptive.

Identify the objects the flow rule is to update. Select:

• On Current Work Item to continue processing on the current (unresolved) work object in the next flow.
• Choose On Another Work Item to start processing on a different work object.
• Choose On Embedded Page to apply this flow to each object in a Split-forEach shape.

Select Regular, Screen Flow or BPMN as the category of the destination subflow to be started.

If the current flow is a screen flow, the subflow must also be a screen flow.

(for On Current Work Item) Select a flow rule by Flow Type, the second key part of the flow rule branched to.

Select to allow users to reenter this subflow at the beginning by clicking a rectangle on the breadcrumbs display. This field works with Perform harness rules that include a breadcrumbs display and with assignments that offer the Previous flow action. In other cases, the value has no effect.

Some flow rules have input parameters. Enter parameters for the selected flow rule.

Optional. Select or enter the name of a Rule-Message rule to control the text of an instances added to the work object history (the "audit trail") when a flow execution completes this shape. Process Commander includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work object history displays can be localized.)

Optionally, to reduce the volume of history detail instances, your application can prevent system-generated messages from being added to work object history. See Controlling the volume of generated work object history instances and the Pega Developer Network article PRKB-25196 How to control history instances written to the audit trail.

Select to indicate that this task is an entry point, which a user can return to using the breadcrumbs control or the standard flow action Work-.Previous. The default is cleared.

If this box and the SubFlow Re-Entry? box are both selected, steps marked as entry points in the subflow disappear from the breadcrumbs display when the subflow execution is complete. The user can restart the subflow execution from the beginning, but can no longer re-enter it at interim entry points.

This field works with Perform harness rules that include a breadcrumbs display and with assignments that offer the Work-.Previous flow action. In other cases, the value has no effect.

This check box appears only when you select the Entry Point? check box. Select to restrict users at runtime who are at this entry point to choose only those entry points (on the breadcrumbs display) that identify earlier steps in the flow.

Leave unselected to allow users to select any entry point of the flow when at this entry point. They can click the breadcrumbs control or tab to complete or visit an earlier or later step.

For maximum user flexibility, leave this check box unselected 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.

Field

Completing the Field

Select the class (work type) of the "other" work object.

Enter a property reference in the current work object that identifies the key (.pzInsKey property) of the other work object. Leave this blank if the (when this shape is reached) the other work object is already open as a page on the clipboard.

Optional. If (when this shape is reached) the other work object is present on the clipboard, enter the page name that holds it. If the other work object is not present, enter the page name to be created that holds it. When you leave this field blank but complete the Work Property field, the system opens the work object on a page named pyNextObj (or pyNextObj_1, and so on).

To start the flow execution, the current requestor must hold a lock on the work object. If the current requestor does not hold or cannot acquire this lock, the system starts a problem flow rather than the designated flow.)

Select Regular, Screen Flow or BPMN as the category of the destination subflow to start.

Select the Flow Type, the second key part of the flow started for the other work object.

Optional. Select or enter the name of a Rule-Message rule to control the text of an instances added to the work object history (the "audit trail") when a flow execution completes this shape. Process Commander includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work object history displays can be localized.)

Optionally, to reduce the volume of history detail instances, your application can prevent system-generated messages from being added to work object history. See Controlling the volume of generated work object history instances and the Pega Developer Network article PRKB-25196 How to control history instances written to the audit trail.

Select to indicate that this task is an entry point, which a user can return to using the breadcrumbs control or the standard flow action Work-.Previous. The default is cleared.

Field

Completing the Field

Enter a reference to the property (of mode Page, Page List, or Page Group) that holds the embedded page.

Identify the class (such as the work type) of the embedded page. You can enter a property reference or expression here.

Select Regular, Screen Flow or BPMN as the category of the destination subflow to be started.

Select the Flow Type, the second key part of the flow to be started for the other work object.

Optional. Select or enter the name of a Rule-Message rule to control the text of an instances added to the work object history (the "audit trail") when a flow execution completes this shape. Process Commander includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work object history displays can be localized.)

Optionally, to reduce the volume of history detail instances, your application can prevent system-generated messages from being added to work object history. See Controlling the volume of generated work object history instances and the Pega Developer Network article PRKB-25196 How to control history instances written to the audit trail.

Select to indicate that this task is an entry point, which a user can return to using the breadcrumbs control or the standard flow action Work-.Previous. The default is cleared.

This check box appears only when you select the Entry Point? check box. Select to allow users at runtime who are at this entry point to choose only those entry points (on the breadcrumbs display) that identify earlier steps in the flow, already completed.

Leave unselected to allow users to visit or complete or revisit the entry points of the flow in any order. Regardless of which step is currently displayed, they can click the breadcrumbs control to complete or revisit any earlier, or later, steps.

For maximum user flexibility, leave this check box unselected if your flow allows inputs to arrive 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.