Configuring a Split For Each shape

The Split For Each shape provides a form of searching or enumeration over the pages in a property. Use a Split For Each shape to iterate over the pages of a Page List or Page Group property. For each page, you can conditionally start a flow execution for the work item.

1. Double-click the Split for Each shape.

2. Complete the fields in the property panel as described in the following table.

   Options include:

   Field	Description
   Join	Select Any, All, Iterate or Some. Choose: Any to cause processing in this flow execution to resume after any one of the split subprocesses completes. At that time, processing of the other split subprocesses — which have not completed — stops. Open assignments for these subprocesses are cancelled. (If you choose Any and at runtime one flow execution ends before some others are started, the others are not started.) All if the current flow is to resume only when all the split flows complete and return. Some if multiple subprocesses are spawned and the flow is to resume when some of the split flows reach a specified status. Iterate to spawn flows for elements of the Page Group or Page List property one-by-one, testing conditions you list below to determine whether to continue. Caution: If you choose Iterate, execution of the subprocesses must not alter the index values in the Page Property value, to prevent unreliable results. For example, if an activity in the subprocess started for the fifth element of a Page List deletes the first element of the Page List, the original sixth element (now fifth) may be unintentionally skipped. When you choose Iterate, the Exit Iteration When and Subprocess has Entry Points fields appear at the bottom of the properties panel. Note: When used in a screen flow, there is no Join option in a Split For Each shape. The only processing mode is Iterate. The conditions When and Abort Iterations are not available. A Page Group property used in a screen flow Split For Each shape is processed in an indeterminate order and all pages are shown. Therefore, Page Group-specific iteration settings are not available; that is, you cannot determine a different order as you can in a regular flow.
   Page Property	Identify the property of mode Page List or Page Group that is the basis of the split. Note: At run time, this shape processes the work item's embedded Page List or Page Group properties; the embedded pages must exist before the Split For Each shape is reached.
   Class	Identify the class of the embedded pages. Usually, this value does not usually need to be altered as the class appears when you enter Page Property.
   Filter Flow Rule By	Select Process Flow or Screen Flow as the category of the destination subprocess to be started.
   Flow Rule	Select a flow (the second key part) for the Foreach over an embedded page list. At runtime, the system uses the value in the Class field to find the flow.
   When	Optional. Select a when condition rule. The system uses the class of the embedded page as the Applies To key part of the when condition rule. At runtime, it evaluates this when condition rule once for each page of the property in the Page Property field, and a starts a subprocess for any page for which this rule evaluates to True. (For Iterate, additional tests are applicable.) For example, you can use this field to start subprocesses only for subscript values "OH" and "VA" of a Page Group property that uses state codes as subscripts.
   Parameters	The Flow Rule you select may accept input parameters that will appear in the box below. Supply a value for each parameter. Parameter values are validated when you save the flow, unless the flow in is Draft mode.
   Exit Iteration When	This field appears only when you select Iterate in the Join field. Select a when condition rule. The system uses the class of the parent flow as the Applies To key part of the when condition rule. If this field is not blank, at runtime the system evaluates this when condition rule once for each page of the property in the Page Property field. If false, no additional flow executions are started and the flow is resumed. For example, you can use this field to exit when a top-level work item property was set to 6 or less, where the subprocess executions contain assignments recording committee member votes, and 6 yes votes count as a majority.
   Exit Iteration	This field appears only when you select Some in the Join field. Select On Count or On When to create the condition which causes processing in the original flow to resume. On Count - Enter the number of paths that must result in a specific status in order to exit the split and resume processing in the original flow. On When - Select a when condition rule. The system uses the class of the parent flow as the Applies To key part of the when condition rule. If this field is not blank, at runtime the system evaluates this when condition upon completion of spawned processes. If true, the Split For Each iteration is exited and flow processing continues. If false, the Split For Each continues to wait for remaining spawned processes to be completed. For example, you can use this field to exit subprocesses only when a top-level work item property was set to 6 or less, where the subprocess executions contain assignments recording committee member votes, and 6 yes votes count as a majority.
   At least... path(s)	Enter the minimum number of paths that must result in a specific status to exit the split and resume processing in the original flow. For example, if a given number of users choose a specific flow action that results in a specified flow status, then processing in the original flow resumes.
   Result with flow status	Identify the status that some flows must reach in order to exit the split and resume processing in the original flow.
   Application	Optional. Select the name of the application that you want to link to the shape.
   Work Type	Optional. Select the name of the work type for the application that you want to link to the shape.
   Audit Note	Optional. Text you enter here appears in the history of the work item, recording the subprocess started by this Split For Each shape. (If you selected Iterate for the Join field, the history is written for each iteration over the work item, even if subprocesses were started only for some.) Note: When you plan to localize the application, 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 localization. See About the Localization wizard.
   Entry point	Select to indicate that this Split For Each shape is an entry point, which provides a navigation link for that step. The links appear after you complete a step. For example, after you complete Step A and go to Step B, a link appears to Step A. Links are displayed according to the type of harness you use: Links in a Perform harness or a screen flow harness display as a breadcrumb trail. A tree navigation screen flow harness displays tree nodes. A tabbed screen flow harness displays a tab. If you click a navigation link for the Split For Each shape, you return to the first step (assignment) and the split runs again. You can click the links in the tree and breadcrumb harnesses to return to any step (subprocess) within the flow. Note: Tabbed and tree harnesses require that Entry Point? be selected. By default, the box is cleared.
   Only going back	Optional. This check box appears only when you select the Entry Point? check box for the Split For Each shape. If selected, users cannot click the Split For Each shape's tab or tree node until they have reached it or passed it. Users cannot jump forward to this step. If you enable jump-forward in your tabbed or tree harness, then configure the last flow action in the screen flow to provide comprehensive validation, in case steps were skipped. 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 shapes that are not entry points. The setting is applicable only to tabbed and tree screen flows. By default, the box is cleared.
   Post action on click away	This check box appears only when you select the Entry Point check box. Select to run flow action post-processing when you click away from this entry point. By default, the box is cleared.
   Subprocess has entry points	In a regular process flow, this field appears only when you select Iterate in the Join field. Select to allow users to return to the entry points within the Split For Each subprocesses using the breadcrumbs control, or clicking a tree-harness node from a completed subprocess or the standard flow action Work-.Previous. For example, assume that a Split For Each shape calls a flow containing two assignments ("Review" and "Approve) and the Page List has three entries. The label property is set to .myString and that the values of .myString on each page of the Page List are pg1, pg2, and pg3. Then the breadcrumbs appear as: pg1 -Review - Approve - pg2 - Review - Approve — pg3 - Review - Approve. Tabbed nodes and tree harnesses require Subprocess has Entry Points to be selected. By default, the box is cleared.
   Label property	Optional. This field appears only when you click the Subprocess has Entry Points check box. Enter the property for the navigation labels used on subprocess tab headers or tree nodes.

3. The Page group interaction settings section appears only when you select Iterate in the Join field. Complete the fields to select the subscript order, indicate whether the subscript requires an exact match, and to specify whether to start a subprocess for subscript values not yet selected.

   Options include:

   Field	Description
   Subscript Order	Optional. Enter the literal text of (or an initial portion of) a subscript value that may be present in the Page Group property at runtime. For example, enter M to match the eight state codes ME, MA, MO, MT, MS, MD, MN, and MI. At runtime, a subprocess is started, one at a time, for each match of the first row. Then a subprocess is started for each match of the second row, and so on. (This requires repeated scanning of the pages in the group to access subscript values.)
   Exact Match	If the Subscript Order field is not blank, click the check box to require an exact match. For example, the value M does not exactly match any state code.
   Process remaining pages	If the Page Group Iterations array is not blank, select to indicate that a subprocess is to be started for any subscript value not yet selected (subject to the Abort Iterations when? result.) For example, if the subscript values correspond to state codes and the array contains the single character M (without exact matching), select this box to create subprocesses for each of the remaining 42 states (in an unspecified order) after creating subprocesses for the eight states that match M.

4. Click OK to close the property panel.

5. Hover on an existing shape in the flow and drag a connector from it to the Split For Each shape.

6. Hover on the Split For Each shape and drag a connector to an existing shape in the flow.

Processing in the original flow pauses while the subprocesses execute. Processing in the original flow can resume after all the subprocesses complete, after some complete, or after the any one of them completes. You can also specify conditions in which the original flow does not send the work item through the second flow.For an example, see the standard flow Work-.StandardApprovalsAll or similar "approvals" flows.

At run time, the standard function rule AddFlow() is called for each page in the Page List property, and limits this to a maximum of 500 new flows. This limit is imposed to detect and trap possible infinite loops. If required by your applications, you can increase or decrease this limit.

Tip: Right-click a Split For Each shape to view more configuration options.

Related information

Open topic with navigation