Default Instance Details template

Edit online

Draft comment:
This topic only applies to BAW, and is located in the BAW repository. Last updated on 2025-03-13 12:15

The ready-to-use Process Portal application that is shipped with IBM® Business Automation Workflow includes a dashboard for displaying details of the process instances. Use this template as the basis for creating a customized default Process Portal dashboard for displaying instance details.

The template contains the following coach views:

The Default Get Related ECM Folders Service is available as a configuration property on the Default Instance Details template. This configuration property can be useful if you want to customize the behavior on the instance details user interface. You can, for example, constrain the number of returned folders to be the folders only appropriate to your application. See the example in Adding references.

The template also contains the following hidden coach views:

The template does not include a Data Section control. Instead, it includes a content box that you can use to create a customized data section. Alternatively, you can reproduce the ready-to-use instance details page, by dropping a Data Section control into the content box.

You can create a customized instance details page from a copy of the template, and then add or remove coach views. You can also customize each of the individual coach views, for example, by updating the configuration properties for the control. For more information, see the documentation for the individual coach controls.

Restrictions and limitations

Restrictions: None

Limitations

The Responsive Document Explorer control is available only for process instances.
If you are migrating process applications created before Business Automation Workflow 8.5.7, such as process applications created with the case editor in Business Automation Workflow 8.5.6, you must add the Responsive Coaches toolkit to your process applications.

Refresh behavior provided by the template

The header of the template contains the following controls to trigger refreshes in the other controls in the coach view. This behavior applies only to nonfederated environments.

The Refresh Controller control automatically triggers refreshes at regular intervals. It is bound to the template's Automatic refresh trigger configuration property.
The Refresh Button control triggers a refresh when a user clicks the button. It is bound to the template's Manual refresh trigger configuration property.
Two Service Controller controls that send boundary events to refresh service variables when the value of the bound variable changes. One of these controls is bound to the Automatic refresh trigger configuration property and the other control is bound to the Manual refresh trigger configuration property.

For a control in the coach view to respond to a refresh request, its Refresh trigger configuration property must be set to the variable that is bound to either the Refresh Controller control or the Refresh Button control.

When a refresh needs to happen, the notifying control changes the value of the bound variable to true, which triggers the refresh of the controls in the body of the view. When the refresh is complete, the value of the bound variable is reset to false.

The template separates manual and automatic refresh so that you can control the refresh behavior of different parts of the user interface.

Automatic refresh: If an automatic refresh is triggered by the Refresh Controller control, the other controls that are bound to the Automatic refresh trigger configuration property are notified, and the corresponding Service Controller control sends a boundary event.
Manual refresh: If a manual refresh is triggered by the Refresh Button control, the template also simulates an automatic refresh. The controls that are bound to either the Manual refresh trigger or the Automatic refresh trigger are notified, and the corresponding Service Controller controls send boundary events.