Flow form — Editing with Process Modeler
Editing the Subprocess shape properties
Flow form — Editing with Process Modeler
|
|
A Subprocess shape 
may represent any of the following:
A
on the shape indicates that one or more tickets are defined on the Subprocess. Assigned ticket names appear beside this icon on the flow.
Check the Spinoff Flow box to cause this shape to start an asynchronous flow execution at runtime, in which the current flow execution continues while the subprocess executes. When this box is checked, 
appears on the Subprocess shape.
On the flow Diagram tab, you can add a shape in one of three ways. Validation of the added shapes occurs when you save the flow.
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.
on the toolbar Flow Shape palette to display a drop-down shapes menu.A subprocess shape may be deleted from the process flow. Right-click the subprocess shape, and select Delete from the drop-down menu.
You can also select the subprocess and do one of the following:
on the toolbar.Note: When a shape is deleted, the connectors to and from the shape are not deleted.
Cut or copy shapes from a flow and paste them within the same flow or in other flows within your user session.
to cut a selected shape(s) and connector(s). Cut differs from Delete in that cut shapes appear faded on the canvas until you paste them elsewhere. You can also cut selected shapes using the right-click canvas menu, or the shape drop-down menu.
to place selected shape(s) and connector(s) in the copy buffer. You can also copy selected shapes using the right-click canvas menu, the shape drop-down menu
to paste selected shape(s) and connector(s) elsewhere in the flow or in other flows within your user session. You can also paste selected shapes using the right-click canvas menu, or the shape drop-down menu.
- Double-click the shape.
- Right-click the shape and select Properties from the drop-down menu.
- Click the shape, then click the toolbar View Properties icon
.
Complete the sections comprising the property panel as described below. If this flow is a screen flow, special rules apply.
The fields that appear depend upon your selection in the Define flow field.
Use the following table to complete the fields if your flow is being defined on the specific work item:
Field |
Description |
| Define flow |
Identify the objects the flow is to update. Select:
|
| Filter flow By |
Select |
| Flow name |
Select the Flow Name, the second key part of the flow to be started for the other work item. |
| Parameters |
Some flows have input parameters. Enter parameters for the selected flow. |
| Work type |
Optional. Select the name of the work type for the application that you want to link to the shape. The value of this field is referenced with the flow diagram in application documents. |
| Audit note |
Optional. Select or enter the name of a Rule-Message rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. The Pega 7 Platform includes a few dozen standard messages in the Work- class. (Through field value rules, you can localize the corresponding text on work item history displays. See About the Localization wizard.) Optionally, to reduce the volume of history detail instances, your application can prevent system-generated messages from being added to work item history. See Controlling the volume of generated work item history instances and the PDN article 25196 How to control history instances written to the audit trail. |
| Spinoff flow |
Select to indicate that this Subprocess is a Spinoff Flow. When a work item advancing through a flow reaches a Subprocess with Spinoff Flow selected, the Pega 7 Platform starts execution of a different flow, using the current or a different work item. Processing in the current flow continues in parallel, without waiting for the other flow to complete. When this box is checked, |
| Entry point |
Select to indicate that this Subprocess shape is an entry point, which a user can return to using the breadcrumbs control or the standard flow action Previous. The default is cleared. This check box works with Perform harnesses that include a breadcrumbs display and with assignments that offer the Work-.Previous flow action. In other cases, the check box has no effect. |
| Only going back |
This check box appears only when you select the Entry Point check box. 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. For maximum user flexibility, leave this check box unselected if your flow accepts inputs in any order. |
| 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. |
| Subprocess has entry points |
In a regular flow, select to allow users to return to the entry points within the 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 Subprocess shape calls a flow containing two assignments ("Review" and "Approve) and the pg1 -Review - Approve - pg2 - Review - Approve — pg3 - Review - Approve. Note: Tabbed nodes and tree harnesses require Subprocess has Entry Points to be selected. By default, the box is cleared. |
Use the following table to complete the fields if your flow is being defined on another work item:
Field |
Description |
| Define flow |
Identify the objects the flow is to update. Select:
|
| Work property |
Enter a property reference in the current work item that identifies the key (.pzInsKey property) of the other work item. Leave this blank if (when this shape is reached) the other work item is already open as a page on the clipboard. |
| Class |
Select the class (work type) of the "other" work item. |
| 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 To start the flow execution, the current requestor must hold a lock on the work item. If the current requestor does not hold or cannot acquire this lock, the system starts a problem flow rather than the designated flow.) |
| Filter flow by |
Select |
| Flow name |
Select the second key part of the flow to be started for the other work item. |
| Parameters |
Some flows have input parameters. Enter parameters for the selected flow. |
| Audit note |
Optional. Select or enter the name of a Rule-Message rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. The Pega 7 Platform includes a few dozen standard messages in the Work- class. (Through field value rules, you can localize the corresponding text on work item history displays. See About the Localization wizard.) Optionally, to reduce the volume of history detail instances, your application can prevent system-generated messages from being added to work item history. See Controlling the volume of generated work item history instances and the PDN article How to control history instances written to the audit trail. |
| Spinoff flow |
Select to indicate that this Subprocess is a Spinoff Flow. When a work item advancing through a flow reaches a Subprocess with Spinoff Flow selected, the Pega 7 Platform starts execution of a different flow, using the current or a different work item. Processing in the current flow continues in parallel, without waiting for the other flow to complete. When this box is checked, |
| Entry point |
Select to indicate that this Subprocess shape is an entry point, which a user can return to using the breadcrumbs control or the standard flow action Previous. The default is cleared. This check box works with Perform harnesses that include a breadcrumbs display and with assignments that offer the Work-.Previous flow action. In other cases, the check box has no effect. |
| Only going back |
This check box appears only when you select the Entry Point check box. 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. For maximum user flexibility, leave this check box unselected if your flow accepts inputs in any order. |
| 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. |
| Subprocess has entry points |
In a regular flow, select to allow users to return to the entry points within the 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 Join shape calls a flow containing two assignments ("Review" and "Approve) and the pg1 -Review - Approve - pg2 - Review - Approve — pg3 - Review - Approve. Note: Tabbed nodes and tree harnesses require Subprocess has Entry Points to be selected. By default, the box is cleared. |
Use the following table to complete the fields if your flow is being defined on an embedded page:
Field |
Description |
| Define flow |
Identify the objects the flow is to update. Select:
|
| Page property |
Enter a reference to the property (of mode |
| Class |
Identify the class (such as the work type) of the embedded page. You can enter a property reference or expression here. |
| Filter flow by |
Select |
| Flow name |
Select the second key part of the flow to be started for the other work item. |
| Parameters |
Some flows have input parameters. Enter parameters for the selected flow. |
| Audit note |
Optional. Select or enter the name of a Rule-Message rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. The Pega 7 Platform includes a few dozen standard messages in the Work- class. (Through field value rules, you can localize the corresponding text on work item history displays. See About the Localization wizard.) Optionally, to reduce the volume of history detail instances, your application can prevent system-generated messages from being added to work item history. See Controlling the volume of generated work item history instances and the PDN article How to control history instances written to the audit trail. |
| Spinoff flow |
Select to indicate that this Subprocess is a Spinoff Flow. When a work item advancing through a flow reaches a Subprocess with Spinoff Flow selected, the Pega 7 Platform starts execution of a different flow, using the current or a different work item. Processing in the current flow continues in parallel, without waiting for the other flow to complete. |
| Entry point |
Select to indicate that this Subprocess shape is an entry point, which a user can return to using the breadcrumbs control or the standard flow action Previous. The default is cleared. This check box works with Perform harnesses that include a breadcrumbs display and with assignments that offer the Work-.Previous flow action. In other cases, the check box has no effect. |
| Only going back |
This check box appears only when you select the Entry Point check box. 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. For maximum user flexibility, leave this check box unselected if your flow accepts inputs in any order. |
| 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. |
| Subprocess has entry points |
In a regular flow, select to allow users to return to the entry points within the 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 Join shape calls a flow containing two assignments ("Review" and "Approve) and the pg1 -Review - Approve - pg2 - Review - Approve — pg3 - Review - Approve. Note: Tabbed nodes and tree harnesses require Subprocess has Entry Points to be selected. By default, the box is cleared. |
Field |
Description |
| Specification | Enter a name to associate a specification with this shape. You can either select an existing specification by selecting Choose another specification from the Specification Actions menu, or by entering text in the field to create a new specification. Enter a description in the text area beneath the specification name. When you click OK in the Assignment Properties dialog, the system creates or updates the specification. See Working with specifications in Process Modeler and Case Designer. |
Complete the Status and Tickets sections as described below.
Complete the Status section 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 |
You can set the status for the work item here. The selected status updates .pyStatusWork when a flow execution reaches this shape. A status indicator appears on connectors to shapes that change a work item status. For example, if the shape status is set to Pending-External, the connector to that shape will display 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.
|
Add a Ticket Name in the Tickets section 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 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 subprocess shape to indicate one or more tickets are associated with this subprocess. Assigned ticket names appear beside this icon on the flow.
Field |
Description |
| Ticket Name |
Creating ticket rules is recommended but not required. You can enter here a name that does not correspond to a ticket rule. If a shape has more than one ticket associated with it, then processing continues with that task only after all tickets are set. 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. |
New
Open
Pending
Resolved
Optional. Select one or more tickets that are to be available at runtime from this subprocess. Add a row for each ticket. Use SmartPrompt to display all tickets available to flows in this work type.