Iterating over information in a flow

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	Choose: 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.

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 Submit to close the property panel.

5. Click Save.

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.

Open topic with navigation