|
|
Flow form — Editing in VisioA Subprocess shape (
) may represent any of the following:
- A branch to another flow without returning (one or more incoming connectors, no outgoing connectors)
- A call to another flow with return (one or more incoming connectors, one or more outgoing connectors)
- Part of a Split Join or Split For Each shape (at least one incoming and one outgoing connector)
Don't confuse the Subprocess shape with the similar Start shape (
). Every flow contains a single Start shape. A Start shape has no incoming connectors.
A flow that is branched to or called by another is sometimes informally called a subprocess or subflow. However, no field on the rule form identifies a flow as a subprocess. The term subprocess describes how a flow execution is started rather than the rule's characteristics.
Use the Spinoff shape rather than a Subprocess shape to start an asynchronous flow execution, in which the current flow execution continues while the subprocess executes. See Flow form — Editing the Spinoff shape properties.
To call or branch to a subprocess
1. Drag the Subprocess icon from the stencil onto the flow and drop it.
2. When the SubProcess Properties appear, complete five fields:
Field |
Description |
| Name |
Assign a name to the shape. Choose a name meaningful to application users who see this on the work item history display, the breadcrumbs control (for entry points), and the Where-Am-I? diagram. It does not affect flow execution.
|
| Define Flow on |
Identify the objects the flow is to update. Select:
|
| Application |
|
| Work Type |
|
| Specification |
|
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.
Optional. 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.3. Complete other fields that appear.
Completing the fields — 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.
|
| Define Flow on |
Identify the objects the flow is to update. Select:
|
| Flow Name |
Select If the current flow is a screen flow, the subprocess must also be a screen flow. |
Flow Rule
|
|
| Subflow Re-entry? |
Select to allow users to reenter this subprocess at the beginning by clicking a rectangle on the breadcrumbs display. This field works with Perform harnesses that include a breadcrumbs display and with assignments that offer the Previous flow action. In other cases, the value has no effect. |
| Parameters |
Some flows have input parameters. Enter parameters for the selected flow. |
| Audit Note |
|
| Entry Point? |
Select to indicate that this shape 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 subprocess disappear from the breadcrumbs display when the subprocess execution is complete. The user can restart the subprocess execution from the beginning, but can no longer re-enter it at interim entry points. This field works with Perform harnesses that include a breadcrumbs display and with assignments that offer the Work-.Previous flow action. In other cases, the value 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. Leave unselected to allow users to select this entry point from anywhere within the flow. They can complete or visit an earlier or later step.
|
25196 How to control history instances written to the audit trail.
For maximum user flexibility, leave this checkbox 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 shapes that are not entry points. Completing the fields — On Another Work Item
If you choose On Another Work Item, complete these fields. This choice is not available for screen flows.
Field |
Completing the Field |
| Class |
|
| Work Property |
|
| Page Name |
Optional. If (when this shape is reached) the other work item is present on the clipboard, enter the page name that holds it. If the other work item 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 item on a page named
|
| Flow Type |
Select |
| Flow Rule
|
|
| Audit Note |
|
| Entry Point? |
Select to indicate that this shape 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. |
Completing the Fields — On Embedded Page
If you choose On Embedded Page, complete these fields. This choice is not available for screen flows.
Field |
Completing the Field |
| Page Property |
|
| Class |
|
| Flow Type |
Select |
| Flow Rule
|
|
| Audit Note |
|
| Entry Point? |
Select to indicate that this shape 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. |
| 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.
|
4. Click Apply .
5. Attach at least one incoming connector to the shape. For a branch to another flow, do not connect any outgoing connectors to the shape. For a call of a subprocess (with return), attach one outgoing connector from the 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.)