Back Forward Flow form
Editing the Spin-off shape properties

About Flow rules

Purpose

When a work object advancing through a flow reaches the Spin-off shape, Process Commander starts execution of a different flow, using the current or a different work object. Processing in the current flow rule continues in parallel, without waiting for the other flow to complete.

Note A flow rule that is reached and started by another is sometimes informally called a subflow; the original is called the parent flow. However, no field on the rule form marks a flow rule as a subflow; the term describes how a flow rule is referenced rather than its characteristics. Some Business Process Management materials use the term subprocess for a branch flow.

NoteUse the Flow shape rather than a Spin-off shape to start a synchronous flow execution, in which the current flow execution pauses while the subflow executes. See Flow form — Editing Call or branch to a subflow shape properties.

Adding a Spin-off task to a flow

1. Drag the Spin-off shape (Split/Join shape) onto the flow and drop it.

2. When the Spin-off Properties panel appears, complete the five fields:

Field

Description

Name

Enter a text name for this shape of 32 characters or less. 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. For example, Begin Contract Processing.BUG-2983

The task name is only descriptive; it does not affect runtime execution of the flow. This name also appears inside the Spin-off shape on the Diagram tab.

Define Flow on

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.
  • On Another Work Item to start processing on a different work object.
  • On Embedded Page to apply this flow to an embedded page.
Application

SmartPromptOptional. 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. 5.4 Proj-831

Work Type

SmartPromptOptional. 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. 5.4 Proj-831

Use Case

SmartPromptOptional. 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 Application Use Case rule. 5.4 Proj-831

On Current Work Item

Complete these fields if you selected On Current Work Item in the Define Flow on field.

Field

Description

Name

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.

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

Define Flow on

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 an object on an embedded page.
Flow Type

Select Regular or Screen Flow. Select Screen Flow if the flow for the other work objects is to consist only of a sequence of assignments (questions) and flow actions (responses).C-1112

Flow Rule

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

Parameters

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

Audit Note

Optional. Text entered here appears as a history instance for the work object, recording that this flow was initiated.

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.

Entry Point?

Select to indicate that this Spin-off 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. 5.2

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

Only going back?

This checkbox appears only when you select the Entry Point? checkbox. 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, clear this checkbox 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.

On Another Work Item

If you choose On Another Work Item, complete the following fields. Complete either the Work Property field, Page Name field, or both. MARIK 3/22/06

Field

Completing the Field

Work Property

SmartPrompt Optional. Enter a property reference in the current work object that identifies the key of the other work object.

Class

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

Page Name

Optional. Identify the page containing the other work object, or a property reference holding the pzInsKey value of the other work object. MARIK 3/17/06

Flow Type

Select Regular or Screen Flow. Select Screen Flow if the flow for the other work objects is to consist only of a sequence of assignments (questions) and flow actions (responses). C-1112

Flow Rule

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

Audit Note

Optional. Text entered here appears as a history instance for the work object, recording that this flow was initiated.

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.

Entry Point?

Select to indicate that this Spin-off 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. 5.2

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

On Embedded Page

If you choose On Embedded Page, complete these fields:

Field

Completing the Field

Page Property

Identify the embedded page on which the spin-off flow is to run; for example, .pyWorkParty("Originator"). MARIK 3/17/06B-21061

Class

Select the work type of the "other" work objects.

Flow Type

Select Regular or Screen Flow. Select Screen Flow if the flow for the other work objects is to consist only of a sequence of assignments (questions) and flow actions (responses). C-1112

Flow Rule

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

Audit Note

Optional. Text entered here appears as a history instance for the work object, recording that this flow was initiated.

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.

Entry Point?

Select to indicate that this Spin-off 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. 5.2

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

4. Click  Apply   when finished.

5. Connect at least one incoming and one outgoing connector to the Spin-off shape.

(To edit these shape properties after you save the Flow form, open the Diagram tab, right-click the shape, and select the Edit tab on the pop-up window.) GRP-202

Up About Flow rules