Instance Tasks Section
Use Instance Tasks Section to provide a coach view that displays a list of tasks for a process or case instance that can be filtered according to a category, such as completed tasks.
- Instance Tasks List control. This coach view provides the list of tasks for the instance.
- Category Selection control. If this control
is enabled, tabbed selection categories are provided at the top of
the task list.
To enable the Category Selection control, bind the selectedCategory and categoriesSelectionList configuration properties in the Instance Tasks Section control to a variable.
Restrictions and limitations
- Restrictions
- This control supports only the Required, Hidden, and None visibility properties.
- To enable navigation actions for the coach 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
| Configuration property | Property variable | Description |
|---|---|---|
| Section title | sectionTitle (String) | The title that is displayed in the section
header. Default: "Tasks" |
| 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 control 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 control height is based on the style attributes
of the control. Default: If the control is not positioned absolutely or has no height or max-heightstyle settings, the height is 600 pixels. |
| Initial list size | initialMaxRows (Integer) | The initial number of tasks that are displayed
in the list. When no value is specified, all the tasks are displayed. |
| Instance ID | instanceId (String) | The instance ID filters the list of tasks.
This property is required. Default: None |
| Selected category | selectedCategory (String) | Displays tasks 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, open tasks 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 tasks, for example, open tasks, and its sort
criteria. Open, Completed |
| 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 control, for example, the Category Selection control to provide tabbed selection categories at the top of the list. Default: Open, Completed |
| Refresh trigger | refreshTrigger (Boolean) | Enables the contents of the control to be
refreshed. Bind this property to the private variable that is used
by the Refresh Controller control, the Refresh Button controls, or
both controls. 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 task list | retrieveTaskListService | The service that retrieves the task list. Default Instance Tasks List Service |
| Tasks | tasks (TaskListItem) (List) | The list of tasks that are displayed. This
property is read-only. Default: An empty list |
| Localization Service | localizationService | The service that is used to retrieve
the globalized strings for use with this coach view Default: Dashboards Localized Messages Loader |
Customizing the Instance Tasks Section coach view
You can customize the Instance Tasks Section coach view in the following ways:- Customize the header of the section in the following ways:
- Change the name of the section by updating the Section title configuration property
- Change the expand and collapse behavior of the view by updating the Collapsible and Collapsed configuration properties
- Add controls to, or remove controls from the section
- Modify resource strings in the Localization Service resource file, for example, to change the title of the section
- Modify the style settings in the .css file