Instance Activities Section

Edit online

Use Instance Activities Section to provide a coach view that displays a list of activities for a process or case instance. The list can be filtered according to a category, such as ready activities, or by a text filter that the user enters.

The Instance Activities Section control is a composite coach view that includes the following individual coach views:

Instance Activities List control. This coach view provides the list of activities for the instance.
Text Filter control. If this control is enabled, a text box is displayed above the list of activities where users can enter a string to limit the activities in the list.
To enable the Text Filter control, bind the textFilter configuration property in the Instance Activities Section control to a variable.
Category Selection control. If this control is enabled, tabbed selection categories are provided above the activities list.
To enable the Category Selection control, bind the selectedCategory and categoriesSelectionList configuration properties in the Instance Activities Section control to a variable.

Restrictions and limitations

Restrictions

This view supports only the Required, Hidden, and None visibility properties.
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.

Limitations: None

Configuration properties

Set or modify view configuration in the Configuration properties tab.

Table 1. Instance Activities Section Configuration properties
Configuration property	Property variable	Description
Section title	`sectionTitle (String)`	The title that is displayed in the section header. Default: "Activities"
Collapsible	`collapsible (Boolean)`	Indicates whether the section can be collapsed. Default: `false` (not collapsible)
Collapsed	`collapsed (Boolean)`	Indicates whether the section is collapsed when the view opens. Default: `false` (not collapsed)
Height	`height (Integer)`	The height of the view in pixels. If the list exceeds the specified height, a scroll bar is shown. To show the complete list without a scroll bar, enter 0. When no value is specified, the height of the control is 600 pixels.
Instance ID	`instanceId (String)`	The instance ID filters the list of activities. This property is required. Default: None
Selected category	`selectedCategory (String)`	Displays activities in the selected category. Default: The first entry in the list of categories that are defined for the Define selectable categories configuration property. If no selectable categories are defined, ready activities are displayed.
Define selectable categories	`categories (List of String)`	Defines the set of selection categories and the order in which they appear in a user interface. A category represents a subset of activities, for example, ready activities, and its sort criteria. The categories can be a combination of predefined and user-defined categories. Default: `Ready`, `InProgress`, `Completed`, `All`
User-defined categories	`userDefinedCategories (List of ActivityListCategory)`	A list of user-defined categories. The names of these categories must be unique and not one of the predefined category names: `Ready`, `InProgress`, `Completed`, or `All`. Default: None
Generated selection categories	`categoriesSelectionList (List of NameValuePair)`	The subset of the selectable categories that you want to include in the user interface. The list is generated from the value of the Define selectable categories configuration property. It consists of name-value pair objects; the name property is the display name of the category, and the value property is the category value. You can bind this configuration property to a selection view, for example, the Category Selection view to provide tabbed selection categories at the top of the list. Default: `Ready`, `InProgress`, `Completed`, `All`
Text filter	`textFilter (String)`	Filters the activity list by activity name based on the text that is entered by the user. Default: None
Refresh trigger	`refreshTrigger (Boolean)`	Enables the contents of the view to be refreshed. Bind this property to the private variable that is used by Refresh Controller, Refresh Button, or both. When the value of the bound variable changes to `true`, the view is refreshed. After the view is refreshed, the value of the variable returns to `false`. Default: `false` (no refresh pending)
Retrieve activities	`retrieveActivityListService`	The service that retrieves the list of activities. Default: `Default Instance Activities List Service`
Activities	`activities (List of ActivityListItem)`	The list of activities that are displayed. This configuration property is read-only. Default: None
Retrieve details of an activity	`retrieveActivityDetailsService`	The service that retrieves the details of an activity. Default: `Default Activity Details Service`
Execute action on activity	`activityActionService`	The service that executes an action on an activity. Default: `Default Activity Action Service`
Localization Service	`localizationService`	The service that is used to retrieve the globalized strings for use with this view `Dashboards Localized Messages Loader`

Customizing the Instance Activities Section coach view

You can customize the Instance Activities Section coach view in the following ways:

Add controls to, or remove controls from the section. For example, remove the Text Filter control by removing the binding to the textFilter configuration property
Customize the categories that are used for filtering activities by changing the values of the corresponding configuration properties. You can delete or replace predefined categories, or adding new user-defined categories. For more information, see Customizing categories
Modify resource strings in the Localization Service resource file, for example, to change the labels of the selection categories
Modify the style settings in the .css file