Refresh Controller
Use Refresh Controller to automatically trigger the refresh of coaches or pages in the
view at regular intervals. To respond to a refresh request, the individual views must be configured
accordingly.
To manually refresh the controls in the view, see Refresh Button control. To trigger the refresh of the controls in a view by using boundary events, see Service Controller control. To ensure that the contents of the view can be refreshed, always include the Refresh Controller, the Refresh Button, and the Service Controller controls in a view.
Restrictions and limitations
- Restrictions
- For performance reasons, the Refresh Controller control can be disabled by the system administrator. For custom instance details pages, always include the Refresh Controller, the Refresh Button, and the Service Controller control in the view to provide a refresh mechanism for the other pages in the view.
- This view does not use the visibility property.
- Limitations
- For a view to be refreshed by the Refresh Controller control, the view control must comply with
one of the following rules:
- The control has a Refresh trigger configuration property that is wired to the variable that is bound to the Refresh Controller control.
- The control responds to boundary events from the Service Controller control.
Data binding
Set the data binding for the view in the General properties
tab.
| Description | Data type |
|---|---|
A variable that enables the automatic refresh of the contents of a view. When
the Refresh Controller control changes the value of the variable to true, views
that are bound to the variable can respond to the refresh request. |
Boolean |
Configuration properties
Set or modify view configuration
in the Configuration properties tab.
| Configuration property | Property variable | Description |
|---|---|---|
| Time between refreshes | refreshInterval (Integer) |
The time in seconds between refresh events that are triggered by the control. The default value is 60 seconds. |
Refresh behavior
The refresh behavior of
the control is determined by the following system custom properties.
For more information about these properties and how change them, see Changing custom properties for Process Portal.
- TimerCoachViewEnabled
- Specifies whether Refresh Controller views are enabled for the system. If this parameter is set
to
false, all Refresh Controller controls in the system are disabled. To ensure that the contents of the view can be refreshed, always include both the Refresh Controller and the Refresh Button controls in a view. - TimerCoachViewRefreshInterval
- A system-wide value for the refresh interval that can override
the value that you specify for the Time between refreshes configuration
property. If the value of the system parameter is set to
-1, the refresh interval that is specified for the Refresh Controller control is used. - MinimumCoachViewRefreshInterval
- A system-wide minimum refresh interval that can be set to help avoid server overload. If the value that you set for the Time between refreshes configuration property is less than the value of the system parameter, the system parameter overrides the refresh interval that is specified for the Refresh Controller control.