|
|
Flow formThe Split For Each shape 
provides a form of searching or enumeration over the pages in a property.
Purpose
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.
Processing in the original flow pauses while the subprocesses execute. Processing in the original flow can resume after all the subprocesses complete, or after the any one of them completes. For an example, see the standard flow Work-.StandardApprovalsAll or similar "approvals" flows.
The 
and 
help to identify the Split For Each shape.
indicates that one or more tickets are defined on the Split For Each shape. Assigned ticket names appear beside this icon on the flow.
You cannot use the Split For Each shape to create work items. At runtime, 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.
Adding a Split For Each shape to the flow
On the flow Diagram tab, you can add a shape to a flow in one of three ways. Validation of the added shapes occurs when you save the flow.
Use the canvas context menu:
- Right-click a blank area of the canvas near the location where you would like the Split For Each shape to appear.
- Hover over Add on the submenu to display a list of shapes you can add to the flow.
- Click the Split For Each shape. After the shape has been added to the canvas, click and drag to reposition.
Use the toolbar Flow Shape palette:
- Click the Flow Shape palette
on the toolbar to display a drop-down shapes menu that will remain open until you close it, facilitating the process of rapidly adding multiple shapes. Click the window title bar and drag the submenu to another area of the screen, as needed. - Click and drag the Split For Each shape to the canvas.
- Close the Flow Shape palette at any time.
Use the Flow Shape palette drop-down menu:
- Click the down arrow
on the toolbar Flow Shape palette to display a drop-down shapes menu. - Click and drag the Split For Each shape from the drop-down menu to the desired position on the canvas.
Editing Split For Each shape properties
1. On the flow Diagram tab, open the properties panel using one of the following:
- Double-click the shape.
- Right-click the shape and select Properties from the drop-down menu.
- Click the shape, then click the View Properties icon
.
2. When the Split For Each Properties panel appears, enter a text name for this shape. The shape name defaults to Split For Each. 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. For example: Customer Limit Check.
The shape name is only descriptive; it does not affect runtime execution of the flow. This name also appears inside the Split For Each shape on the Diagram tab.
To change the name after you have exited from the properties panel, click the name, and type over the highlighted text.
3. Complete the fields as described in the tables below. (To edit the shape properties after you save the Flow form, open the Diagram tab, right-click the shape, and select Properties.)
4. Click OK or click anywhere off the shape to save edits and close the panel.
5. Click and drag the shape as needed to position it in the flow.
6. Connect an incoming connector to the Split For Each shape.
7. Connect an outgoing connector from the Split For Each shape.
Deleting a Split For Each shape from the flow
A Split For Each shape may be deleted from the process flow. Right-click the Split For Each, and select Delete from the drop-down menu.
You can also select the Split For Each and do one of the following:
- Click Delete
on the toolbar. - Press the Delete key on your keyboard.
When a shape is deleted, the connectors to and from the shape are also deleted.
Completing the Split For Each tab
Complete the Split For EachTab to select the join type, process flow type, when condition rule, and the process flow to use at runtime.
Field |
Description |
| Join |
Select
When you choose
|
| Page Property |
|
| Class |
|
| Filter Flow Rule By |
Select |
| Flow Rule |
|
| When |
For example, you can use this field to start subprocesses only for subscript values "OH" and "VA" of a |
| Parameters |
The Flow Rule you select may accept input parameters that will appear in the box below. Supply a value for each parameter. PRPC validates these parameter values when you save the flow. (unless the flow in is Draft mode). |
| Exit Iteration When |
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 start 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. |
| 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. |
| Specification |
Optional. Select the name of the specification for the application and work type that details the implementation requirements for the Split For Each 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
|
| 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:
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.
By default, the box is cleared. |
| Only Going Back |
Optional. This checkbox appears only when you select the Entry Point? checkbox 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.
By default, the box is cleared. |
| Post Action on Click Away |
This checkbox appears only when you select the Entry Point checkbox. 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 For example, assume that a Split For Each shape calls a flow containing two assignments ("Review" and "Approve) and the pg1 -Review - Approve - pg2 - Review - Approve — pg3 - Review - Approve.
By default, the box is cleared. |
| Label Property |
|
If you choose 
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 Page Group Iteration Settings tab
The Page Group Iteration Settings tab 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..
Field |
Description |
| Subscript Order |
Optional. Enter the literal text of (or an initial portion of) a subscript value that may be present in the 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 checkbox 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. |
Complete the Work Status field under the Status tab to set the status for the work item. This allows you to easily change the status at multiple points in the life cycle of a work item without adding a Utility shape to the flow for each status change. Similar to setting work item status using a Utility shape, setting the status on this tab invokes the UpdateStatus activity. Any defined tickets dependent on the status are raised, as appropriate.
Field |
Description |
| Work Status |
A status indicator appears on connectors to shapes that change a work item status. For example, if the status is set to Pending-External, the connector to that shape displays a small red flag. All transitions connecting to the shape will display the status indicator. Following are the status indicators for the four status prefixes.
|
New
Open
Pending
ResolvedAdd a Ticket Name field under the Tickets tab to indicate the ticket(s) available at runtime. Use the Ticket to mark the starting point for exceptions that may arise at any point in the flow, such as a cancellation. The ticket is a label for a point in a flow, much like a programming "GOTO" destination.
An activity executing anywhere in your entire PRPC application can set or raise this ticket by executing the Obj-Set-Tickets method with this ticket name as a parameter. See Ticket help for other ways to raise a ticket.
The scope of a raised ticket includes all flows on the current work item that contain this ticket. If found, processing stops on that flow promptly, and resumes at the ticket point.
The system adds to the split for each shape to indicate one or more tickets are associated with this split for each shape. Assigned ticket names appear beside this icon on the flow.
Field |
Description |
| Ticket Name |
ExampleProcessing is connected to a ticket to respond to an exception, error flow or event. For example, if a mortgage application is withdrawn after some, but not all, of the application processing is completed, a mortgage processing flow can:
|
| Display Name | Optional. The Ticket Name appears by default. Enter a name to display other than the ticket name. |
Optional. Select one or more tickets that are to be available at runtime from this split for each. Add a row for each ticket. Use SmartPrompt to display all tickets available to flows in this work type.At runtime, 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. See More about Flows.