Flow form
Process Modeler — Smart Shapes

Field

Description

Select to attach a file to the case.

Select to attach a URL to the case.

Select to attach a note to the case.

Appears if you select Attach a file. Select if you wish to attach a binary file.

Appears if you select Attach a file. Select if you wish to reference an attachment from the case type.

Select the category to assign to the attachment. The category helps identify the business purpose for the attachment.

Required, if you selected Reference a Binary file attachment.

Required, if you select Attach a Note. Enter a note that will appear on the case.

Required, if you selected Attach a URL.

Required. Enter a description of the attached content.

Optional. Select or enter the name of a field value rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. PRPC includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work item history displays can be localized. 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 PDN article How to control history instances written to the audit trail.

Select to indicate that this Utility 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.

Because a utility shape presents no user form, if a user clicks a breadcrumbs control to return to this entry point, flow processing resumes and pauses at the next assignment or other shape that requires user input.

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.

Leave unselected to allow users to select this entry point from anywhere within the flow. They can complete or visit an earlier or later step.

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 decision shapes, or that have intermediate tasks that are not entry points.

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.

Field

Description

Select to create a top level case. This invokes the utility pxCreateTopCase.

Select to create one or more child cases. This invokes the utility pyCreateSubcasesFlow.

Select to create more than one child case. This invokes the utility pyCreateSubcases.

Required, if you select Create multiple cases. Select a pagelist property. The pxAddChildWork activity creates a case for each item in the list.

Required, if you select Create a top case or Create a subcase. Select the case type you would like to create. All coverable cases appear.

If you select Create multiple subcases, the field is optional. If no value is provided, the class of each child case is determined by the class of each page in the specified pagelist.

To create a case using a parameter or property value rather than specifying a case type, select Other. In the empty field that appears, select a property from SmartPrompt or enter a parameter.

Appears if you select Create a top case or Create multiple subcases. Select the data transform rule for setting properties for all child cases.

If you do not select a data transform and the CopyPageData parameter of the pxAddChildWork activity is set to true, all page data from the parent or the entry in the PageProperty parameter is copied to the child case.

Appears if you select Create a top case. Select the property that stores the top case ID.

Starting processes

Appears if you select Create a subCase or Create multiple subcases. Select a flow in this case type to designate it as a starting process. All inherited flows appear. When you enter at least one flow, this case type rule – not the Creates a new work object? check box on the Flow form's Process tab – defines the starting processes. The system disables the check box on all Flow rule forms in this case type; flows not in the list are designated as non-starting processes. If you leave this list empty, use the check box on the Flow rule form to configure starting processes.

Appears if you select Create multiple cases.

Optional. Select or enter the name of a field value rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. PRPC includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work item history displays can be localized. 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 PDN article How to control history instances written to the audit trail.

Select to indicate that this Utility 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.

Because a utility shape presents no user form, if a user clicks a breadcrumbs control to return to this entry point, flow processing resumes and pauses at the next assignment or other shape that requires user input.

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.

Leave unselected to allow users to select this entry point from anywhere within the flow. They can complete or visit an earlier or later step.

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 decision shapes, or that have intermediate tasks that are not entry points.

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.

Field

Description

Required. Select an existing section to associate with the API.

Enter text that explains the purpose of the PDF attachment.

Select the category to assign to the attachment. The category helps identify the business purpose for the attachment.

Select a Landscape (default) or Portrait layout orientation.

Optional. Select or enter the name of a field value rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. PRPC includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work item history displays can be localized. 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 PDN article How to control history instances written to the audit trail.

Select to indicate that this Utility 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.

Because a utility shape presents no user form, if a user clicks a breadcrumbs control to return to this entry point, flow processing resumes and pauses at the next assignment or other shape that requires user input.

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.

Leave unselected to allow users to select this entry point from anywhere within the flow. They can complete or visit an earlier or later step.

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 decision shapes, or that have intermediate tasks that are not entry points.

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.

Field

Description

Use the drop-down menu to select current or other operator. If you select Other, choose the operator that appears on the post.

Required. Enter the message you would like to post to PegaPulse.

Click to indicate the message is about the current case.

Appears if you indicated that this message is about the current case. Click to make the post secure, or available only to those with access to the case.

Optional. Select or enter the name of a field value rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. PRPC includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work item history displays can be localized. 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 PDN article How to control history instances written to the audit trail.

Select to indicate that this Utility 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.

Because a utility shape presents no user form, if a user clicks a breadcrumbs control to return to this entry point, flow processing resumes and pauses at the next assignment or other shape that requires user input.

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.

Leave unselected to allow users to select this entry point from anywhere within the flow. They can complete or visit an earlier or later step.

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 decision shapes, or that have intermediate tasks that are not entry points.

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.

Field

Description

Use the drop-down menu to select who to send the push notification to:

• All User of the Application
• Access Group
• Individual

Once selected, use the field below the menu to designate the recipient(s).

Enter the message to send to users in the push notification.

A badge is used to indicate the number of messages available. Use this field to specify the source for displaying the number of unread messages.

Select this check box to sound an alert on a user's mobile device when a push notification is received. If left unchecked, no sound will be made upon receipt.

Optional. Select or enter the name of a field value rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. PRPC includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work item history displays can be localized. 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 PDN article How to control history instances written to the audit trail.

Field

Description

Select from the following:
Email address to indicate that you would like to send email to one or more specific addresses.
Party to indicate that you would like to send email to one or more specific parties.

Select to indicate that you would like to send email to one or more specific parties.

Required, if you select party. Enter or select the work parties you would like to send mail to.

Required, if you select Email address. Enter one or more addresses, using a text string or a property reference, and a comma separator between addresses.

Required. Enter a text string or a property reference.

Click the appropriate radio button to create your message with the Rich Text Editor or a Correspondence template.

Required, if you clicked the Correspondence radio button in the Message section above. Use the SmartPrompt to select the correspondence template.

Appears if you select the Rich Text radio button. Use rich text editing features to compose your email.

Appears if you select Party. Check the box to include attachments.
Click the appropriate radio button:
All — Select to include all case attachments in the email.

By category — Select to include only attachments that belong to categories you specify in the using the SmartPrompt in the Categories field that follows .

Optional. Select or enter the name of a field value rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. PRPC includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work item history displays can be localized. 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 PDN article How to control history instances written to the audit trail.

Select to indicate that this Utility 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.

Because a utility shape presents no user form, if a user clicks a breadcrumbs control to return to this entry point, flow processing resumes and pauses at the next assignment or other shape that requires user input.

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.

Leave unselected to allow users to select this entry point from anywhere within the flow. They can complete or visit an earlier or later step.

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 decision shapes, or that have intermediate tasks that are not entry points.

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.

Field

Description

Select to update a single case.

Select to update all child cases and descendants.

Required, if you select A Single Case. Enter the case ID or a property reference.

Required. Select the data transform rule for setting properties for this case.

If you do not select a data transform and the CopyPageData parameter of the pxAddChildWork activity is set to true, all page data from the parent or the entry in the PageProperty parameter is copied to the child case.

Optional. Select or enter the name of a field value rule to control the text of an instances added to the work item history (the "audit trail") when a flow execution completes this shape. PRPC includes a few dozen standard messages in the Work- class. (Through field value rules, the corresponding text on work item history displays can be localized. 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 PDN article How to control history instances written to the audit trail.

Select to indicate that this Utility 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.

Because a utility shape presents no user form, if a user clicks a breadcrumbs control to return to this entry point, flow processing resumes and pauses at the next assignment or other shape that requires user input.

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.

Leave unselected to allow users to select this entry point from anywhere within the flow. They can complete or visit an earlier or later step.

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 decision shapes, or that have intermediate tasks that are not entry points.

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.

Field

Description

Use the drop-down menu to select one of the following:

• Reporting Structure – route the case based on the value of the Work group or Reports to: field specified on the Work tab of the current operator's Operator ID rule
• Authority Matrix – route the case based on a decision table that evaluates a condition, then routes the case to a specified operator based on the results of that condition. For example, expense reports for over $1,000 may require a higher level of management approval than expense reports for $100.

Appears if you selected Reporting Structure. Select:

• Reporting Manager – to route the case to the ID specified in the Reports to: field on the Work tab of the current operator's Operator ID rule
• WorkGroup Manager – to route the case to the manager of the workgroup specified in the Work group field on the Work tab of the current operator's Operator ID rule

Appears if you selected Reporting Structure.

• One — Route cases for approval only to the manager selected in the Approval to be completed by field.
• All — Route cases for approval up the entire management hierarchy, starting with the select manager.
• Custom — Route cases for approval up specific levels in the management hierarchy as determined by the evaluation of when records.
  
  

Appears if you selected Custom. Specify a when rule that determines the approval level required if that condition is met.

Appears if you selected Custom. For each when condition, enter a number that represents the management levels a case must be routed to based on the results of the when condition.

Example

Assume James Allen (current operator) reports to Bill Glover, Sales Manager, who reports to Carol Roland, Division V.P. (Level 2), who reports to Sam Scott, CFO (Level 3).

All purchase requests must be approved by Bill Glover. The first when condition states that a purchase request totaling more than $25,000 must be approved by Bill Glover and Carol Roland. You enter 2 in the Levels of Approval field. The second when condition states that if the request is greater than $75,000, it must also be approved by Sam Scott. You enter 3 in the field.

Appears if you selected Authority Matrix. Specify the decision table that determines the approver for the case. This field is not mandatory. However, if a value is not provided, you must pre-populate the following two fields: Page list property and Approver property.

Specify the page list property that stores the result of the evaluated decision table.

Specify the property that stores the resulting approver.

Select to send an email to the individual specified in the Approval to be completed by field. An email listener and account must be configured for the work group. See About the Email wizard.

Field

Description

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

Field

Description

Optional. 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 work type. The ticket name will appear beside the icon on the flow.

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.

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

Optional. The Ticket Name appears by default. Enter a name to display other than the ticket name.