Process Instances List

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15
Use Process Instances List to show the list of instances for a specified business process. Several filters control the actual selection.
Table 1. Process Instances List configuration properties
Instance configuration label Description Definition configuration option Default value
List title Header that contains the title. When no value is specified, the list title is hidden. listTitle (String) (empty)
Retrieval service The service that retrieves the process instances list retrieveProcessInstanceListService (Default Process Instance List Service) Default Process Instance List Service
Height The height of the list in pixels. When no value is specified, the default height is 600 pixels. height (Integer) (empty)
Number of instances displayed The initial number of rows displayed in the control. initialMaxRows (Integer) (empty)

When no value is specified, a maximum of 25 rows are displayed by default.

Risk state Process instances that are currently in the risk state. Valid values are OnTrack, AtRisk, and Overdue. riskState (String) (empty)
Step Process instances that are currently in the specified activity step. stepId (String) (empty)
Step risk state Process instances that are currently in the specified activity step under stepId and the specified risk state of the step. This option has no effect when stepId is not set. Valid values are OnTrack, AtRisk, and Overdue. stepRiskState (String) (empty)
Search filter Process instances that contain the specified text searchFilter (String) (empty)
Process application ID The ID of the process application for the instances that are displayed. Either the process application name or the process application ID must be specified. If both values are set, the process application ID is used. appId (String) (empty)
Process ID The ID of the process for the instances that are displayed. Either the process name or the process ID must be specified. If both values are set, the process ID is used. processId (String) (empty)
Process application name The process application name for the instances that are displayed appName (String) (empty)
Process name The process name for the instances that are displayed processName (String) (empty)
Estimated completion service The service that retrieves the estimated completion information retrieveEstimatedCompletionService (Default Instance Estimated Completion Service) Default Instance Estimated Completion Service
Process instances The list of process instances that are currently displayed. This is a read-only option. processInstances (list of ProcessInstanceListItem) objects (empty list)

This view does not use the visibility property.

To enable navigation actions for the view in a custom dashboard, also add the Navigation Controller control to the custom dashboard. For more information, see Navigation Controller control.