Changing custom properties for Process Portal by using wsadmin commands

Several IBM® BPM custom properties are available for modifying the default behavior of Process Portal. For example, you can change the refresh behavior of the Process Portal process instance page.

Important: The following information applies to both Heritage Process Portal (deprecated) and Process Portal.
The custom properties are stored in the configuration repository. You can use the following wsadmin commands to get, set, and delete values for the custom properties.
Table 1. Process Portal custom properties
Runtime behavior Custom properties
Default URL template for external implementations External implementations are used to integrate custom web-based user interfaces (UIs) in Process Portal. The URL template specifies a pattern for the URL that is used to launch the UI.
The following custom properties are available for specifying a default URL template for the IBM BPM system. Use variables that are surrounded by curly brackets to include runtime information, such as the task local and environment context.
ProcessServer.ExternalActivityDefaultURL
The custom property for BPD systems. For example:
http://mySystem/taskCompletion/{tw.system.task_id}
BPC.ExternalActivityDefaultURL
The custom property for BPEL systems. The URL can include replacement variables. For more information, see Replacement variables in human tasks.
For example:
http://localhost:9080/bpc?tkiid=%htm:task.instanceID%
Refresh behavior of the process instance details page A process instance details page can contain several different mechanisms for refreshing the data, including the Refresh Controller coach view and the client-side human service event handler. Both of these mechanisms trigger the refresh of the instance details page at regular intervals.
The following custom properties are available for modifying the refresh behavior.
TimerCoachViewEnabled
The default value is true.
Refresh Controller coach view
Enables Refresh Controller coach views. If this property is set to false, all Refresh Controller coach views in the system are disabled.
Client-side human service event handler
Enables the event handler to regularly refresh the instance details page that is based on the values of the timer custom properties. If this property is set to false, the client-side human service must provide an alternative refresh mechanism, such as a Refresh button, to ensure that the page is refreshed.
TimerCoachViewRefreshInterval
Specifies the refresh interval in seconds for the process instance details page. The default value is -1.
Refresh Controller coach view
The specified value can override the value of the Time between refreshes configuration property in individual Refresh Controller coach views. If the value of the custom property is set to -1, the refresh interval that is specified for the Refresh Controller coach view is used.
Client-side human service event handler
  • If the value of the custom property is set to -1, the refresh interval is determined by the MinimumCoachViewRefreshInterval custom property.
  • If the value of the customer property is greater than the value of the MinimumCoachViewRefreshInterval custom property, the event handler uses the value that is specified here.
MinimumCoachViewRefreshInterval
Specifies the minimum refresh interval in seconds for the process instance details page. You can use this property to help reduce server overloads due to page refreshes. The default value is 10 seconds.
Refresh Controller coach view
If the value of the Time between refreshes configuration property in a Refresh Controller coach view is less than the value of the custom property, the custom property overrides the configuration property.
Client-side human service event handler
If the value of the TimerCoachViewRefreshInterval custom property is less than the value of this configuration property, the even handler uses the value that is specified here.
Online status of users.
Attention: Process Portal can now display online status data.
The following custom property is available for enabling or disabling online status data.
ProvideOnlineStatusData
Specifies whether online status data is displayed. The default value is true.