Process Portal mashup custom properties

By setting mashup custom properties in the administrative console, administrators can modify the default behavior of Process Portal or Heritage Process Portal (deprecated) for individual users or groups.

Process Portal custom properties

available.locales

To add a locale for a language variant, such as British or Australian English, or Colombian Spanish, edit the available.locales property from the WebSphere® Application Server administration console. Write the values in lowercase, separate the value elements with a dash (-), and separate the values with commas, as follows: en-gb,en-au,es-co

com.ibm.bpm.portal.autoRefreshDelay

The task list is updated whenever there is a task change that affects the current user. When the auto-refresh is enabled for the task list, the list is populated by a saved search that contains a full text search, and numerouss tasks are created over a short period of time, numerous expensive REST calls are triggered, which affect performance. To eliminate the expensive REST calls, there is a delay refresh period that is set by default to 100 milliseconds.

To change the default refresh period for the list of saved searches, add this mashup property and restart the server to reflect the changes:

com.ibm.bpm.portal.autoRefreshDelay={millisecond refresh period}

com.ibm.bpm.portal.defaultDashboardDisplayOrder

By default, dashboards in Process Portal are shown in the following order. Unless the com.ibm.bpm.portal.defaultStartPage property is configured or the Process Portal user customized the order of the dashboards, the Work dashboard displays as the start page because it is the first one in the list.

Work‬
Processes‬
‪Process Performance‬
‪Team Performance

The value of the property is the value that you set in the Process Admin Console for the Portal Dashboard Display Order attribute. Users can change the default order when they log in to Process Portal. The order is saved when they log out.

For more information about setting the dashboards order in the Process Admin Console, see Setting the Process Portal tab order for a user group.

com.ibm.bpm.portal.defaultNextTaskSavedSearch

Use this property to define the name or identifier of the saved search that is used to determine which tasks the Next Task dashboard shows to all the users who are allowed to see this dashboard. If the property is not set, the built-in default saved search is used.

com.ibm.bpm.portal.defaultStartPage

The value of the property depends on whether the start page is a saved search or a dashboard:

Saved search

/tasks/queries?query=query_name

where query_name is the URL-encoded form of the saved search name.

For example, if your saved search name is My Saved Search 1, the value will be

/tasks/queries?query=My%20Saved%20Search%201

Dashboard

/dashboards?dashboard=human_service_name

where human_service_name is the URL-encoded form of the name of the human service that contains the dashboard.

For example

/dashboards?dashboard=https%3A%2F%2Fmycompany.com%3A9443%2Fteamworks%2FexecuteServiceByName
%3FprocessApp%3DTWP%26serviceName%3DTeam%2BPerformance%26snapshot%3Dtest1

Attention: If a value is specified for this property, it overrides the value of the com.ibm.bpm.portal.defaultDashboardDisplayOrder property.

com.ibm.bpm.portal.defaultTaskListView

You can set the property to one of the following values: list, table. This property has no effect when the Next Task dashboard is displayed.

com.ibm.bpm.portal.disableCometD

In single Business Automation Workflow environments, CometD is enabled by default. To disable CometD, set the value of this property to true. To get the latest updates when CometD is disabled, Process Portal users can click the Refresh button in the header bar or reload the browser page.

com.ibm.bpm.portal.disableOpenInNewWindow

The property type is java.lang.String. By default, this property is set to false. Set it to true to completely disable the capacity to open tasks, dashboards (including the Work dashboard), and startable services in new windows, both at system and user preference levels. In this case, the property overrides both the user preference and the openTaskInNewWindow property, which applies to all users in the system.

com.ibm.bpm.portal.disableSocial

All social features are enabled by default. You can disable some or all of the features by setting the value of the property to a comma-separated list that contains one or more of the following values: following, mentions, experts, stream; or to all.

com.ibm.bpm.portal.disableTaskAutoRefresh

By default, the task list is automatically refreshed when tasks are updated on the server. If you have teams with many members, you might want to reduce the load on the server by disabling automatic refresh of the task list.

To disable automatic refresh, set the com.ibm.bpm.portal.disableTaskAutoRefresh property to true. Process Portal users are notified when updated tasks are available. They can then refresh their task lists to get the latest changes.

Note: Task lists are refreshed as described here only when cometD is enabled. When cometD is disabled, task refresh is disabled, too, whatever the value of the disableTaskAutoRefresh property.

com.ibm.bpm.portal.displayTimeTracking

Set the value of the property to true. The data includes the number of tasks of a particular type that an experienced user completed and the average time that was spent on a task. By default, time-tracking data is not shown.

com.ibm.bpm.portal.doNotClaimExternalUI

To turn off the ability to claim tasks that were implemented by using an external user interface (that is, not based on a coach), set this configuration property to true. Its default value is false. This property controls the Process Portal behavior, not runtime behavior. For example, if a flow is designed to automatically claim tasks when a process starts, this property does not affect the flow behavior.

com.ibm.bpm.portal.excludeMembershipInfoFromUserInfoRestApis

Set the value of the property to true.

Attention: If this property is set, the Work dashboard cannot automatically refresh because membership information is not available. Ensure that you also disable the automatic refresh custom properties com.ibm.bpm.portal.disableCometD, com.ibm.bpm.portal.disableTaskAutoRefresh, and com.ibm.bpm.portal.federatedRefreshInterval

The following custom properties continue to work normally:

com.ibm.bpm.portal.restrictModifyTask
com.ibm.bpm.portal.restrictModifyTask.reassign
com.ibm.bpm.portal.restrictModifyTask.due
com.ibm.bpm.portal.restrictModifyTask.priority
com.ibm.bpm.portal.hideWorkDashboard

com.ibm.bpm.portal.excludeReferencedFromToolkit

Set the value of the property to a comma-separated list that contains one or more of the following values that correspond to an exposed item type or subtype: process, report, scoreboard, dashboard, startable_service, url, administration_service; or to all.

com.ibm.bpm.portal.federatedRefreshInterval

By default, the value of the property is 60 seconds. To disable automatic refreshing, set the value of the property to 0 (zero).

com.ibm.bpm.portal.hideWorkDashboard

Determines who cannot see the default Work dashboard. Set the value of the property to a comma-separated list of valid security groups, for example tw_admins1, tw_admins2. To hide the page from all users, set the value of the property to all.

com.ibm.bpm.portal.inactivity.monitor

The property type is java.lang.String. By default, this property is set to false. Set it to true to enable the service for monitoring inactivity.

com.ibm.bpm.portal.inactivity.stopMonitorWhenOpenInNewWindow

Determines whether the idle timeout monitor must be stopped when a task is opened in new window. The property type is java.lang.String. By default, this property is set to false.

com.ibm.bpm.portal.inactivity.thresholdInSeconds

The property type is java.lang.String. Use this property to set the number of seconds after which the user is considered to be inactive in Process Portal. The default value is 0 (zero).

com.ibm.bpm.portal.launchList.showMore.count

This property works in relationship with the incremental and full values of the strategy property. The minimum count value is 10.

If the user sets a value that is not strictly positive (such as characters or a negative value), the count value defaults to 25.
If the user sets a positive value from 0 to 9, the count value defaults to 10.

com.ibm.bpm.portal.launchList.showMore.strategy

The strategy property defines a lazy loading policy: saved searches other than the favorite ones are not displayed immediately but only when the user clicks Show More. This property can take the following values:
- incremental is the default value: each click on Show More displays the additional number of saved searches that is defined by the value of the count parameter. If the list contains more elements than the count value, the user must click Show More again to display the next ones.
- The full value loads the complete list of elements to display when the user clicks Show More.
- The preload value loads the complete list of elements for immediate display, without waiting for the user to click Show More. This value reflects the previous default behavior and is not recommended because it reduces display performance.

com.ibm.bpm.portal.openTaskInNewWindow

To open a task in a new browser window, set the value to true. Process Portal users can change the behavior in their user profiles so that tasks open in Process Portal. Even if you do not set this property, users can still change the default browser behavior in their user profiles.

Attention:

If a task has a custom web-based user interface that is based on an external implementation, it always opens in a new browser window regardless of the value of this custom property.
When the disableOpenInNewWindows property is set to true, it overrides the openTaskInNewWindow property.

com.ibm.bpm.portal.restrictModifyTask

Based on user roles, determines who can see the Modify Task action. In the Modify Task window, you can also restrict who can see the individual modification actions by using the following custom properties.

com.ibm.bpm.portal.restrictModifyTask.reassign: Determines who can see the reassign actions.
com.ibm.bpm.portal.restrictModifyTask.due: Determines who can see the due date fields.
com.ibm.bpm.portal.restrictModifyTask.priority: Determines who can see the priority field.

Set the value of the property to a comma-separated list of valid security groups, for example tw_admins1, tw_admins2. To hide an action, set the value of the property to none. If you do not set a value for a property, everyone can see the action.

IBM Business Automation Workflow V19.0.0.3

Important: All the restrictModifyTask properties listed earlier take effect on the client side, which means that even though users cannot see the actions in Process Portal, they can still modify the action owners through REST API, as long as they have the authorized action policy. Consistency must be ensured between the configuration property and the action policy. For more information about the Process Portal action policies, see Configuration properties for Process Portal action policies.

com.ibm.bpm.portal.returnTaskToTeamOnLogout

Use this property to determine what happens when users who work with the Next Task dashboard log out.

If the property is not set to any value

The logout behavior is unchanged: the user who has just logged out remains the task owner.

If the property is set to one of the valid values

If, moreover, the user works on a task that was opened through the Next Task dashboard and that user log outs without finishing the task, the task is assigned back to the user team.

If the property is set to all, the logout behavior applies to all users.
If the property is set to a comma-separated list of user groups, the logout behavior applies to all the users who belong to that group.

com.ibm.bpm.portal.showNextTaskDashboard

By default, the Next Task dashboard is hidden. When you set this property, this dashboard is added to the Show more list and contains a comma-separated list of the groups that are allowed to display it.

If the showNextTaskDashboard property is set to all, the Next Task dashboard is shown to all users.
To allow only some users to display the dashboard, set the property to a comma-separated list of user groups.

com.ibm.bpm.portal.stream.attachments.extensions.blacklist

A comma-separated list of the file extensions that cannot be added to the stream. For example: exe,jar,zip.

com.ibm.bpm.oauth.reauth.allowed

This property is of type java.lang.String. Its default value is false. Set it to true to allow users to re-authenticate after a session timeout.

com.ibm.bpm.oauth.reauth.logoutTimeoutInSeconds

This property is of type java.lang.String. Use this property to set the timeout, in seconds, before users are logged out if they fail to re-authenticate when they are prompted to do so. The default value is 60 seconds.

com.ibm.bpm.oauth.reauth.logoutTimeoutInSecondsWhileReauth

This property is of type java.lang.String. Use this property to set the timeout, in seconds, before users are logged out after they started the re-authentication process. The default value is 120 seconds.

com.ibm.bpm.social.enableDeferNewWindowOpen

If the launch-in-new-window-enabled property is set to true, a new window opens to display the coach when you open a task in the Process Portal Work tab. To avoid about:blank in the address bar, configure this property to defer loading the iFrame in the new browser window or tab.

Click New and add the com.ibm.bpm.social.enableDeferNewWindowOpen property.
Set the property to true.
Keep the default java.lang.String type.
Click OK, and then click Save.
Stop and restart the entire environment, including cluster members, node agents, and the deployment manager for a network deployment environment.

com.ibm.bpm.social.enableRunInFrame

To run Process Portal in an HTML frame, set the value to true.

com.ibm.bpm.social.restRequestTimeoutSeconds

To allow long-running REST requests time to complete, set the value of the property to an integer that corresponds to the number of seconds for the timeout.

com.ibm.bpm.social.zResumable

To allow long-running REST requests time to complete, set the value to a list of process application IDs that contain the services, for example TRD,RD,MAILCOM.

Attention: Because the ready-to-use dashboards are not resumable, do not add either the Process Portal or Heritage Process Portal process application to the list.

For more information about designing resumable services, see Enabling resumable services.

Heritage Process Portal custom properties (deprecated)

com.ibm.bpm.portal.disable.taskCollaboration: Set the value of the property to false. This setting removes the Collaborate option from the Heritage Process Portal user interface.
com.ibm.bpm.portal.doNotClaimExternalUI: The default value of this property is false. Set it to true. This property controls the Heritage Process Portal behavior, not runtime behavior. For example, if a flow is designed to automatically claim tasks when a process starts, this property does not affect the flow behavior.
com.ibm.bpm.portal.streamTags: Set the value to a comma-separated list of HTML tags, for example br,p,sup.
com.ibm.bpm.social.dashboardsToOpenInNewWindow: The value is a list of comma-separated values that specify which dashboards to open in new windows. The format is either the processName or processName:serviceName. For example, if you have a dashboard with the URL ProcessPortal/dashboards/DSVC/Dashboard+HS, the value of the custom property is DSVC or DSVC:Dashboard+HS.
com.ibm.bpm.social.hideDetailsInErrorDialog: Detailed error information might not be suitable for all Process Portal users. To hide the plus (+) icon and the error details, set the value of this property to true.
com.ibm.bpm.social.useAccessibleTooltip: Set the value of the property to true to enable users to use the keyboard to tab to hover help.
com.ibm.mashups.productname: If a product name update is needed, set the default property value to the new product name.