How to use stages to present the chevron view of work item status
You can group work item statuses into stages. During work item processing, stages are represented by descriptive, sequential chevrons that appear in the application. Stages present application users with a simple view of where a work item is in the process. The chevron representing the current task changes color, providing a visual indicator for the work that is finished and the work that remains for the item.
A stage is a field value rule (such as Work-.pyStatusGroup) or a text constant that maps to one or more work status field values (Work-.pyStatusWork). A stage can be configured on:
- the Stages tab of a CaseType rule form
- the Details tab of the Case Designer landing page (> Processes & Rules > Case Manager > Case Designer)
Before you create stages for presenting the user with a high-level view of the tasks to be performed, consider your work process and the status of work items as they progress through the flow. Determine logical groupings for the tasks and decide how you may use the status of work items to provide the user with information about an item's progress.
For example, in a sample call to a center for equipment repair, customer information is collected, the warranty is validated, equipment failure information is gathered, a determination is made whether or not to dispatch a repair person or take another action, a manager approves an on-site repair visit, the visit is scheduled, parts are ordered, a return trip is scheduled to install the parts, payment is collected, and a customer satisfaction survey is completed. The status of the work item changes as actions are completed to resolve the case. When you create a map between the status types and stages, you provide the user with a quick indication of the work completed and remaining before the case is resolved.
You can set status of a work item (Work-.pyStatusWork) on a shape in the flow such that as the work item completes the actions associated with the shape, its status changes to the value specified on the shape's Status tab. You can also use activities to set status. See Developer Help for more information on setting status.
- Determine the statuses used in your flow. You may establish new or alter existing statuses as appropriate for your application. To see statuses available to your application, click > Processes & Rules > Processes > Status Values.
- Create the stages that present information to the user about progress of work items through the process. In this example, configure stages using the Details tab of the Case Designer Landing Page (> Processes & Rules > Case Manager > Case Designer).
- Beside Stages, you see that None are defined. Click (Edit) to define your stages.
- Be default, the stage fields are populated with text constant values and are not mapped to work status values and so must be configured.
- Enter the names of the stages that will appear as labeled chevrons in the application. Use to add further stages. You can enter a text string or use the SmartPrompt to select field value instances.
- The SmartPrompt only lists field value instances with an Applies To class of the case type and the Field Name of pyStatusGroup, similar to the following where Field Value is the name of the stage:
- Map statuses to stages. Note that the status values (pyStatusValue) are not restricted by case type. Click the stage chevron on this screen to add the Status value(s) you would like to map to the stage. You do not have to define stages for all work statuses in a process. Click OK.
- Include the section Work-.pxWhereAmIChevronView in your work harness to display the stage view to users of the application.
- View the stages you created. Users of the application can now view stages to determine the progress of the work item through the process.
Published February 1, 2012 — Updated October 7, 2014