Using the Stages & Processes tab |
The Stages & Processes tab on the Case Designer landing page enables you to design your application by describing the stages within a case type, and then define the steps that happen in each stage. Select a case type on the Cases Explorer to begin your configuration.
A stage is a first level of organizing the tasks required to complete work associated with a case. For example, you may use checklist to capture the large, and then small, tasks needed to complete a job or project. That checklist is similar to a stage.
You identify the high level groupings (stages), then organize the required and optional tasks as steps in the stage diagram. This approach lets you get a sense of what you have to do first, what must happen in sequence, and what can happen in parallel. A a set of step types are available in the Stages & Processes tab; each is processed as a flow. When you add a step and define its type, the system automatically creates the appropriate flow.
A stage can be configured with required and optional steps and actions, which can range in scope from a single assignment to complex, multi-step processes. Stages are a means of sequencing those tasks and establishing dependency relationships between them. Optional actions are available during the appropriate stage, but are performed at the discretion of the user.
The layout of a case lifecycle management design appears as a horizontal sequence of chevrons and boxes; each chevron is a stage and the boxes beneath them are the a stage's steps. The processing sequence is indicated by a number on each chevron label.
After all of the steps in a stage have been completed, the system can automatically transition to the next stage, while controlled transitions allow cases to move to any stage. You can also block entry into a stage if initial criteria are not met, or skip a stage entirely if certain conditions are met.
After all stages are completed, the case can be resolved. To indicate this point – and to prevent the case from transitioning automatically to another stage – you can designate a stage as a resolution stage. The resolution stage acts as a visual indicator of the end of the lifecycle of the case (Stage 4. Closure in the above example), but does not automatically resolve the case.
Depending upon your stage and step configurations, the stage shapes and step boxes are modified to indicate the settings. Select Actions > Legend to see descriptions for each of the variations.
As a best practice, cases should not exceed nine stages; parent cases should include at least three stages. Remember that stages are a tool to aid in managing a process. For example, if two stages fully describe the lifecycle of a case, additional stages may make the design more difficult to understand and develop.
A sub-case typically contains fewer than three stages as it represents a relatively small part of the overall business process.
When you add case types either from the Cases Explorer or Application Express, the system displays one default stage, which contains a default single-step assignment (pzDefaultStageStep). The placeholder stage enables you to process a sample case without further configuration and demonstrate stage-based case processing. The stage is meant to be removed or replaced as you begin developing your application.
If your case types are not configured for stages (for example, the case types were created in V6.3, or you manually deleted all the existing stages), the tab displays only the case type's processes in one of three ways. Select one of the following icons to control the presentation:
— Show images of the Process Modeler diagrams in a vertical array. A green border indicates a starting process. Click the image to open the flow rule. To create a flow, select the Click to add a new process in the empty frame at the bottom of the array to open a Create Flow Record form.
— Show images in a horizontal array. Use the arrows beneath the diagrams to scroll the display.
— Display a list of processes and their classes. Click a process name to open its form.
To start a stage-based design, click the Add Stage button. The system creates a default stage and step.
For information about the controls in the Case Designer header, see About Case Designer landing pages.
To add a stage to an existing diagram, do one of the following:
To delete a stage and its steps, place the mouse pointer on a stage shape, click the down arrow icon , and select Delete stage.
Place the mouse pointer on a stage shape, click the down arrow icon , and select Configure stage behaviors to open the Stage Configuration dialog.
Enter the following:
Item |
Description |
Stage Name | Enter a name that appears as a label on the shape. |
Stage entry validation | Select a validate rule that tests whether the tasks and processes in the stage can begin. If the validation fails, the user is returned to previous stage with validation error messages. |
Skip stage when |
Select a when rule that must evaluate to true in order for the system to automatically skip the steps in this stage and proceed to the next stage. This setting not available on last stages — they cannot be skipped. |
Service level for stage |
Select a service level record to set goal, deadline, and past deadline dates and actions for the stage. The service level starts when the case enters a stage, and ends when the case leaves a stage or when the process within the stage stops. |
Is this a resolution stage? |
Select Yes to indicate that the case cannot transition to another stage for further processing. The setting does not necessarily mean that the case is resolved. A red line appears beneath the chevron as a visual indicator. If you select Yes, the When all stage process are completed or skipped fields do not appear. |
When all stage processes are completed or skipped |
Select one of the following:
You can configure automatic or manual transitions to the next stage within a stage step using any of the following:
For example, if you select the |
Optional Processes |
Add a process that users can manually start within this stage only. Allowed When — Identify the When Name key part of a when rule. This rule must evaluate to true to enable the process. |
Optional Actions |
Add a flow action that users can manually start within this stage only. Allowed When — Identify the When Name key part of a when rule. This rule must evaluate to true to enable the flow action. |
Item |
Description |
Stage entry validation | Select a validate rule that tests whether the tasks and processes in the stage can begin. If the validation fails, the user is returned to previous stage with validation error messages. |
Attachment validation |
Select an attachment category that validates whether an attachment of this category is attached to the case before it can enter this stage. To associate attachment categories with this case type, use the Attachments setting on the Case Designer landing page Details tab. |
To rearrange to stage sequence, select Edit Stages in the Case Designer landing page header. In the Edit Primary Stages dialog, hover your mouse pointer to the left of the stage you want to move. Drag and drop the stage above or below the desired row. Click OK. The system automatically rearranges the chevrons on the tab and adjusts the stage sequence to ensure automatic stage transition.
To delete a stage, do one of the following:
The system automatically adjusts the stage sequence to ensure automatic stage transition.
Your stage design represents the primary path through which cases progress as work is completed. You may require alternate stages that are not part of "normal" processing, but must be available under certain circumstances. These alternate stages can only be accessed manually, and therefore, are not in sequence relative to the other stages.
For example, while building an insurance application, the designer considers that some claims are fulfilled and some claims are denied as part of normal disposition. Occasionally, when a claim is denied, the customer engages a lawyer to dispute the decision. This scenario is not part of normal processing, and does not need to be a primary stage of the case type. However, the end user needs to be able to manually transition the case to an alternate stage, such as Legal Engagement, as needed.
The table below provides examples that describe the methods you can use to transition cases among stages.
Method |
Can go to Primary stage |
Can go to Alternate stage |
Make Change Stage flow action available on Actions menu. |
Yes |
Yes |
Add Change Stage shape to a utility step in a flow; no UI. |
Yes |
Yes |
Use pxChangeStage API in an activity or a rule that calls activities. | Yes | Yes |
Use stage configuration to automatically transition to the next stage when all processes are complete. | Yes | No |
To add alternate stages, select Actions > Configure Alternate Stages in the landing page header. The alternate stage and step images appear beneath the first primary stage chevron
.
Configure the stages and steps as described above for primary stages.
To hide the alternate stages, select Actions > Hide Alternate Stages.
By default, the system writes history records for the following stage-related processing steps and displays them on a user form's Audit tab:
To determine which work history steps appear for a case type in your application, copy the standard decision tree Work-.FilterHistory into your application ruleset with an appropriate Applies To class, and update your copy as desired. See Flows — Controlling the volume of generated work item history instances.
If you enter an audit note in the Change Stage flow action or Smart Shape, your note overrides the standard note generated by the system and is not affected by the filter history settings noted above.
Within each stage, you can add one or more steps. To add a step:
Hover your mouse pointer over the new step, click the down arrow icon , and select Configure step behaviors. The Step Configuration dialog appears. Do the following:
Single Step Assignment
, Multi Step Process
, Case
, Attachment
, or Approval
. The default is single step. If you change selections, a warning reminder appears indicating the change is not reversible.All Step Configuration dialogs contain the following fields:
Item |
Description |
Step type |
Select one of the following:
|
Start Step |
Select either:
|
Only run when |
Optional. Select a when rule that must evaluate to true in order for the system to start according to the Start Step selection. |
Use service level | Optional. Select a service level rule for this step. If you have defined a flow SLA for this step, the step SLA takes precedence. See Flow form — Completing the Process tab. |
Launch on re-entry? | Not available if you selected upon completion or skip of previous step. Select if you want to initiate the step again if case processing enters this stage again. For example, a subsequent stage may be configured to return to this stage. Selecting this option allows the step to run its process. |
The Case step type presents the following fields:
Field |
Description |
Click one of the three radio buttons to indicate the case(s) you would like to create. Below the radio buttons, the fields and parameters appropriate for your selection appear. | |
Create a top case |
Select to create a top level case. This invokes the utility pxCreateTopCase. |
Create a subcase |
Select to create one or more subcase. This invokes the utility pyCreateSubcasesFlow. |
Create multiple subcases |
Select to create more than one subcase. This invokes the utility pyCreateSubcases. |
For each item in list |
Required, if you select Create multiple cases. Select a pagelist property. The pxAddChildWork activity creates a case for each item in the list. |
Case type |
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 subcase is determined by the class of each page in the specified pagelist. |
Data transform |
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. |
Property to store ID of top case |
Appears if you select Create a top case. Select the property that stores the top case ID. |
Starting process |
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. |
Source page parameter name |
Appears if you select Create multiple cases. Identify the page that contains data to be propagated to the sub-case. |
Copy page data to new subcase |
Copies the data from the embedded page to the newly created sub-case. |
In the Approval type field, select either:
Your selection dictates the fields that appear.
Field |
Description |
Approval to be completed by |
Select one of the following:
|
- If approved then - If rejected then |
Select one of the following:
|
Enable email approval |
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. |
See Cascading Approval in Process Modeler - Smart Shapes for a description of the fields in this panel
This step provides a form that enables the user to attach a file and its associated attachment category to a case.
Complete the following fields:
Field |
Description |
Category |
Select an attachment category defined for this case type. If you do not specify a category, the default Work-. File attachment category in Pega-ProCom (no security settings) and any attachment categories defined in the case type are available to the user at runtime. As a best practice, create categories using the Attachments option on the Case Designer landing page Details tab. The Required for Resolution setting on the Attachments dialog is ignored. The user must add an attachment in the Attachment step in order for the process to advance. |
Instructions |
Enter a text description of the attachment. This text appears as a heading in the Attachment form. If you leave this field blank the default Attach File heading appears. |
To automatically attach content to a case, use the Attach Content Smart Shape. See Process Modeler - Smart Shapes.
The user form configuration feature available for single-step assignments allows you to:
To create a form:
To edit a form:
This option does not appear if the referenced section has been directly updated in the record form.
The Process Outline feature enables you to configure the processes and shape properties represented by the stages and steps on the Stages & Processes tab. To switch to this view, hover your mouse pointer beneath the last step in a stage and click the Configure process detail link.You can also use Process Outline to design processes that are not configured in a stage-based design by clicking a process tile.
For more information , see Using Process Outline.