Process Diagram control

Use the Process Diagram control to display process data in a visual diagram that can be annotated with additional information based on configuration options.

Table 1. Process Diagram configuration properties
Instance configuration label Description Definition configuration option Default value
Zoom Level Valid values for the process diagram zoom level are 1 through 10. zoomFactor (Decimal) (empty)
Process ID The business process definition ID of the process diagram to be displayed. A snapshot ID or branch ID is required. processId (String) (empty)
Snapshot ID The snapshot ID for a particular process (begins with 2064.xxx) snapshotId (String) (empty)
Branch ID The branch ID for a particular process (begins with 2063.xxx) branchId (String) (empty)
Project ID The project ID for a particular process (begins with 2066.xxx)

When a process ID is used, the project ID can be used in place of a snapshot ID or branch ID.

projectId (String) (empty)
Process Instance ID The business process definition instance ID. This option takes precedence over the process ID option. instanceId (String) (empty)
Activity Summaries The list of activity summaries to display. This option is applicable only when the process ID option is used. activitySummaries (ActivitySummary) (List) (empty list)
Show Activity Summaries Controls whether activity summaries are shown. This option is applicable only when the process ID option is used. showActivitySummaries (Boolean) False (not selected)
Risk State The selected state of an activity when showing activity summaries. Valid values are OnTrack, AtRisk, and Overdue. riskState (String) (empty)
Step ID The selected activity step ID when showing activity summaries stepId (String) (empty)
Traversed Path The list of link IDs to highlight to show the traversed path. This option is applicable only when the process instance ID option is used. traversedPath (String) (List) (empty list)
Projected Path The list of activity IDs along the projected path to highlight. The activities must be given in the flow order. This option is applicable only when the process instance ID option is used. projectedPath (String) (List) (empty list)
Custom Path The list of projected path link changes for the custom path. This option is applicable only when the process instance ID option is used. customPath (ProjectedPathLinkChange) (empty list)
Localization Service The service that is used to retrieve the localized strings for use with this Coach View localizationService (dashboards Localized Messages) Dashboards Localized Messages Loader
Available Actions The list of available actions that the user is authorized to perform from the process diagram availableActions (String) (List) (empty list)

This coach view does not use the visibility property.