Back Forward Flow form
Process Modeler — Editing Assignment shapes

About Flows
  1. About 
  2. New 
  3. Diagram 
  4. Parameters 
  5. Pages & Classes 
  6. Design 
  1. Process 
  2. Specifications 
  3. Requirements 
  4. Test Cases 
  5. History 
  6. More... 

Complete the Assignment Property panel to define the processing that occurs when a flow execution reaches the Assignment shape .

indicates that an SLA is applied to the assignment.

indicates that one or more tickets are defined on the assignment. Assigned ticket names appear beside this icon on the flow.

indicates that one or more notifications are generated from this assignment.

Purpose

Add an assignment shape for each place in the business process that requires human judgment and input.

For every assignment, add at least one flow action. The assignment normally appears on the worklist of the user who executes the flow.

Adding an Assignment shape

On the flow Diagram tab or in Process Outline, you can add a shape in one of three ways. Validation of the added shapes occurs when you save the flow.

Use the canvas context menu:

  1. Right-click a blank area of the canvas where you would like the Assignment shape to appear.
  2. Hover over Add on the submenu to display a list of shapes you can add to the flow.
  3. Click the Assignment shape. After the shape has been added to the canvas, click and drag to reposition.

Use the toolbar Flow Shape palette:

  1. 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.
  2. Click and drag the Assignment shape to the canvas.
  3. Close the Flow Shape palette at any time.

Use the Flow Shape palette drop-down menu:

  1. Click the down arrow on the toolbar Flow Shape palette to display a drop-down shapes menu.
  2. Click and drag the Assignment shape from the drop-down menu to the desired position on the canvas.

After adding a shape, add connectors as follows:

Deleting Assignment shapes

An assignment may be deleted from the process flow. Right-click the assignment, and select Delete from the drop-down menu.

You can also select the assignment and do one of the following:

NoteWhen a shape is deleted, the connectors remain on the canvas.

Cutting, copying, and pasting Assignment shapes

Cut or copy shapes from a flow and paste them within the same flow or in other flows within your user session.

Previewing the Harness

Click Assignment shape, then click the on the toolbar to preview the Harness associated with the shape.

Editing Assignment properties

  1. Do one of the following to open the Assignment Properties dialog:
  1. When the Assignment Properties panel appears, enter a name, no longer than 128 characters, to the right of the shape title (Assignment: [Assignment]). 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. The system automatically enters the name in the Specification section. The shape name is only descriptive; it does not affect runtime execution.

This name appears inside the Assignment shape on the diagram. You can edit the name by double clicking the shape's label on the diagram. To change the name after you have exited from the properties panel, click the name, and type over the highlighted text.

  1. Complete the fields as described in the tables below.
  2. Click OK to save edits and close the panel.

Completing the property panel sections

Complete the sections comprising the property panel as described below. If this flow is a screen flow, special rules apply. Continue with Flow Rules — Editing in Process Modeler — Creating and Editing a Screen Flow.

Actions

This section appears only when opening an Assignment in Process Outline on the Case Designer Stages & Processes tab.

Use this section to add flow actions to this assignment, define the steps they connect to, and add fields to actions. The system automatically draws the connector for each action you define.

To add an action, click +Add Action. Define the following:

Field

Description

Action

Select a flow action in your application RuleSet stack from the autocomplete list.

To create a new flow action, referenced section, and data properties, enter a name. Use the Configure Form link to add data properties and automatically create the flow action and its referenced section in the Form Configuration dialog. When you complete the dialog, the system creates the flow action, referenced section, and properties in the flow's case type and the current application's highest unlocked RuleSet version. The short description in the Action field is concatenated to create the Name key part for the flow action and section records. The section is populated with the properties defined in this dialog.

Connects to

Select a shape that you want the action to connect to. The default values is the End shape.

When you create a Single Step Assignment or Multi Step Process on the Stages & Processes tab, the system automatically enters the Step name in the Action field as a placeholder description. The second assignment appends _Step2 to the name. By default, the Outcome is End. You can modify the description or delete the default placeholder and select an existing flow action.

Tab out of the field. The following links are available.

Routing

Field

Description

Route To

Select one of the following to send the work to the party or process that will complete the assignment.

  • Current Operator — The current operator's worklist. Default.
  • Operator — The worklist of another operator in the work group. Select an operator in the autocomplete field.
  • Workbasket — A workbasket referenced in the current application. Select a workbasket in the autocomplete field.
  • Custom — A party or process as defined by an assignment activity and router.

If this assignment is within a Swimlane that has a router activity, it is a best practice to use the same router for both shapes.

Assignment Type

Appears when you select Custom in the Route To field. Select an assignment activity using the drop-down menu. Activities with an Assign Activity Type are available.

Standard activities defined with Work- as the Applies To class are always choices in this field. (Your application may include others or override these standard activities.)

  • WorkList — Causes the assignment to be placed on the worklist of the current operator (or of another operator identified by a Router). Creates an instance of the Assign-Worklist class.
  • WorkBasket — Causes the assignment to be placed in a workbasket determined by an associated Router. Creates an instance of the Assign-Workbasket class.
  • Dependency — Causes the assignment to be placed in a workbasket, determined by an associated Router, and wait for an instance of a specified case type (under the same top-level case type) to reach a specified work status in order for the assignment to automatically complete and resume the process (called a mid-process dependency). Creates an instance of the Assign-Workbasket class. A Declare Trigger rule is automatically created in the Applies To class of the case type that activates the assignment. See the description in About theDependency Declare Trigger rule later in this topic.
  • External — Starts the directed Web access feature, sending a temporary assignment by email to a party identified in the work item who is not an interactive PRPC user. Creates an instance of the Assign-External class.
  • Agent — Sends the assignment to a background process rather than to a person (rarely used, similar to WorkBasket ).
  • ArchiveQueueList — Reserved — Do not use.

(Another standard assignment activity Assign-.Connect activity is used internally when creating an instance of the Assign-Connect class and to support BPEL processing. Do not use this for assignments directly.)

Router

Appears when you select Custom in the Route To field. Select a router activity. If you leave the field blank, the default is ToCurrentOperator.

ParametersThe assignment activity you select may accept input parameters that will appear in the box below the Router field. Supply a value for each parameter. PRPC validates these parameter values when you save the flow. (unless the flow in is Draft mode).

Specification

Field

Description

Specification

Enter a specification name to associate a specification with this shape. If you change the default shape name [Assignment], the system enters the name in this field. You can either:

  • Choose an existing specification by selecting Choose another specification from the Specification Actions menu.
  • Create a new specification by entering a name (or keeping the name entered by the system).

Enter a description in the text area beneath the specification name. When you click OK on the Properties panel, the system creates or updates the specification. See Working with specifications in Process Modeler and Case Designer.

Service Level Agreement

Field

Description

Service Level

Optional. Select a service level record to apply to this assignment. See Associating a service level rule with an assignment task. Default in Work- is the default service level.

Advanced

Complete the Assignment Details, Local Actions, Notifications, Tickets, and Optimization sections as described below.

Assignment Details

The settings you supply depend on the assignment type you select.

Field

Description

Harness nameIdentify the Purpose key part of a harness the system is to use to present this assignment. (The system uses the Applies To key part of this flow as the first key part of the harness.)

By convention, the Purpose key part has the value Perform, or another name starting with the word Perform.

The action section in the harness you identify affects the presentation of flow action choices at runtime. The most appropriate choice depends on user skills, the complexity of the actions, and likelihood values. See Presenting flow actions.

Instructions

Select a field value rule for the worklist column Instructions that describes the task that users perform to complete the assignment. Click the Open Rule icon magnifying glass to review the field value rule or define a new field value rule. The SmartPrompt lists field value rules with an Applies To key part equal to the work type of the flow (or a parent class) and a Field Name key part of pyInstructions.

Examples of instructions are "Evaluate and accept or reject" and "Fulfill as soon as possible." Use wording that clearly states what users are expected to accomplish.

NoteWhen you plan to localize the application using this rule, so the application can support users in various languages or locales, 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 later localization. See About the Localization wizard.

Confirmation note

Enter text to display in a confirmation form presented to the user when the flow action is complete.

NoteWhen you plan to localize the application using this rule, so the application can support users in various languages or locales, 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 later localization. See About the Localization wizard.

Do not performWorkList or WorkBasket activities. Select so that when this assignment is reached, do not consider it eligible for the 'Look for an assignment to perform setting on the flow action that was submitted. The settings prevents the activities from overwriting the newAssignPage page, allowing a pre-existing page to be performed instead. This option is useful for performing an assignment on a spun-off work item.
Work Status

Enter a work status in this field 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 invokes the UpdateStatus activity. Any defined tickets dependent on the status are raised, as appropriate. The selected status updates .pyStatusWork when the flow execution reaches this assignment 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 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

Resolved

Effort Cost You can associate a cost value (in any units) with this assignment. For each work item, the system computes the sum of these cost values for the specific path it takes through the flow. A standard Declare Expression rule records this sum as the value of property Work-.pyTotalFlowActionCost.
Allow auto-processCheck this box to specify that the assignment automatically follows the path and flow action of the first when condition that evaluates to true.
WhenSelect a when rule identifying the condition(s) that cause this assignment to automatically take this path. The conditions are evaluated in the order listed at design-time. The assignment takes the first path that evaluates to true. If no when rules evaluate to true, the assignment uses likelihood to determine which connector to follow.
Perform ActionSelect a flow action to execute if the when condition evaluates to true.
Enable link if using bread crumb trailSelect to indicate that this assignment 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 selected.

This checkbox works with Perform harnesses that include a breadcrumbs display and with assignments that offer the Previous flow action. In other cases, the checkbox has no effect.

Perform post-processing when navigating backThis checkbox appears only when you select the Enable link... checkbox. Select to run flow action post-processing when you click away from this entry point.
Status Assign

If this parameter appears, you can enter an assignment status value (not a work item status value). If you leave this blank, the assignment has no status.

Use Current Operator When Basket Not Found

WorkBasket activity. Select to redirect the assignment to the current operator if the workbasket is not defined. (This parameter is used by the Work-.WorkBasket activity.)

Do Not Perform

WorkList or WorkBasket activities. Select so that when this assignment is reached, do not consider it eligible for the 'Look for an assignment to perform' setting on the flow action that was submitted. Select to prevent the activities from overwriting the newAssignPage page, allowing a pre-existing page to be performed instead. This option is useful for performing an assignment on a spun-off work item. (This parameter is used by Work-.WorkBasket and Work-.WorkList activities.)

OperatorModel

External activity. Identify the Operator ID that serves as a model for the external operator. (This parameter is used by the Work-.External activity.)

Days to Expiration

External activity. Enter a positive integer for a number of calendar days after which the external assignment expires, unless completed. (This parameter is used by the Work-.External activity.)

Party

External activity. Identify the party role (such as Customer, Originator, or another role) of the party within the work item who is to receive the external assignment. (This parameter is used by the Work-.External activity.)

Subject

External activity. Enter text to become the subject line of the email message sent to the external party. (This parameter is used by the Work-.External activity.)

Message

External activity. Optional. Enter a phrase or sentence to appear in the body of the email message sent to the external party, above the system-generated URL link. (This parameter is used by the Work-.External activity.)

Corr NameExternal activity. Optional. Identify the Corr Name key part of a correspondence rule to appear in the body of the email message sent to the external party. The resulting output appears above the system-generated URL link. (This parameter is used by the Work-.External activity.)
Dependent On

Dependency activity. The Class Name of the case type that the waiting workbasket assignment is dependent upon for completion. This case type and the flow's Applies To class must be under the same top-level case type in the case management hierarchy. To help avoid deadlocks and as a best practice, do not enter a case type that has a parent or child relationship with the flow's case type.

When an instance of the Dependent On case type reaches the value in the Dependent Status field, the system automatically completes the assignment and advances the flow.

For Dependent Assignment types, the system automatically creates a dependency Declare Trigger in the Applies To class entered in the Dependent On field.

Dependent StatusDependency activity. Select a work status that the dependent-on case type instance must reach in order to complete the assignment.
Action to Take

Dependency activity. Select the connector flow action (exiting this assignment shape) that is called when the dependency condition is met. Cannot be used with local flow actions.

Scope

Dependency activity. Optional. Select an ancestor class that is common to both the waiting case and the DependentOn case. Choose a class low enough in the structure to limit the scope to those specific instances, yet not satisfy any given instance that is waiting.

Scope gives the user the ability to have a dependency fulfilled only when a direct descendent, such as a child or grandchild case, satisfies the dependency condition.

For example, order O-1 contains two shipments that each contain a single item. S-1 contains I-1, and S-2 contains I-2. With Item specified in the DependentOn field, Shipment paperwork cannot begin until at least one item from a Shipment case has completed. If no Scope value is specified, then satisfying one dependency will fulfill all Shipment dependencies. However, if you provide a Scope value of Shipment, dependencies are only fulfilled by direct descendents, or Items in a Shipment case. Completion of I-1 allows shipment paperwork for S-1 to begin.

Complete Dependent When

Dependency activity. Optional. Specify a when condition rule in the dependent-on class that is applied to the Dependent Status value before the dependency condition can be met. For instance, "Wait for a ReceivePayment instance where amount >= $1000 to reach status of Payment-Cleared".

Wait for all cases?Dependency activity. Select so that all instances of the depends-on case type (under that same top-case type) must meet the dependent status before completing the assignment. Otherwise, the first depends-on instance that reaches the status condition completes the assignment.

You can use the standard flow @baseclass-.pyWaitForCase, which employs a Decision shape and two Dependency assignments (Wait for Dependency and Wait for all Dependencies) to determine flow action outcomes for each condition. Add the flow to a Subprocess, Split For Each, or Split Join shape, and enter the flow's parameter values in the shape's Properties panel. The Decision shape uses the WaitForAllCase parameter to determine which Dependency assignment to use.

About Dependency Declare Trigger

For Dependency assignments, the system automatically creates a Declare Trigger in the Applies To class entered in the Depends On field.

The form's Triggers tab contains .pyStatusWork in the One of these Properties Was Modified array. In the Trigger Activity area, pxCheckFlowDependencies appears in the Name field.

The trigger must be able to obtain a lock on the waiting assignment in order to complete it. If it cannot, the work is queued to be completed later. The Process Flow Dependencies agent (System-Queue-FlowDependency-.pzProcessFlowDependency activity) periodically rechecks the lock status until a lock is available.

As a best practice, do not use the When field in the trigger to control conditional dependency behavior. Doing so may prevent the case from leaving the dependent assignment in certain configurations. Rather, use the Complete Dependent When field on this panel.

Local Actions

Complete the fields under the Local Actions to select local flows and specifications to be available at runtime.

TipStrive to anticipate and include all the local flow actions that users may ever need. Some local actions let users respond to conditions that happen rarely but are important when truly necessary.

For example, you may want to define and include local flow actions that let users bypass approvals, exceed normal limits, cancel assignments, and so on. Remember that such local flow actions may be restricted through privileges that are available to only some users, and that user selections of flow actions are recorded in work item history.

Neglecting to allow for such real-world situations may make your application seem rigid and unforgiving to users and managers.

Optionally, you can associate a specification with each flow action. Progress through the Specification fields from left to right (Application > Work Type > Specification) as each selection filters the available values in the following field.

Field

Description

Local Action

Append Select one or more local flow actions that are to be available at runtime from this assignment. Use SmartPrompt to display all flow actions available to flows in this class.

At runtime, local actions appear in the order listed here.

Specification Application

Select the application that contains the specification you want to use with this local flow action. Use SmartPrompt to display all applications available to flows in this class.

Specification Work Type

Select a work type that contains the specification you want to use with this local flow action. Use SmartPrompt to display all work types available in the application you selected.

Associated Specification

Select a specification to associate with this local flow action. Use SmartPrompt to display all specifications available in the work type you selected.

If you have associated a specification, the system adds it to the For Flow Components array on the flow rule's Specifications tab when you click OK on the Assignment Properties dialog.

Notifications

Field

Description

Notify

Select a notify activity here. The system adds to the assignment shape to indicate that correspondence is created as the assignment is created.

Parameters

The notify activity 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.

Tickets

Add a Ticket Name 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 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 assignment shape to indicate one or more tickets are associated with this assignment. The name(s) of assigned tickets appear beside this icon on the flow.

Field

Description

Ticket Name

add row Select one or more tickets that are to be available at runtime from this assignment. Add a row for each ticket. Use SmartPrompt to display all tickets available to flows in this case type. The ticket name will appear beside the icon on the flow.

TipCreating ticket rules is recommended but not required. You can enter here a name that does not correspond to a ticket rule.

NoteIf a shape has more than one ticket associated with it, then processing continues with that task only after all tickets are set.

Example

Processing 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:

  • Include a ticket named Withdrawn on a utility shape that computes the fees due for work done so far, and any refund amount
  • Follow the utility shape with another that produces correspondence, to alert all parties working on the mortgage that it was withdrawn
  • Connect to external systems to back out (rollback) changes or void accounting entries as appropriate
Display Name The Ticket Name appears by default. Enter a name to display other than the ticket name.

Optimization

Field

Description

Optimization Property

add rowSelect one or more single value properties to use for optimization. You can override this setting for a single optimization run using the Optimization Criteria panel on the Overlays drop-down menu. See About the Process Optimization Tool.

Up About Flows