Configuring custom properties

• Process Portal

Left menu pane in task details and instance details pages

Keep the left menu pane always open in the instance details pages. When you open a task details or instance details page in Process Portal, the left menu pane is by default hidden.

<server merge="mergeChildren">
<portal merge="mergeChildren">
<always-open-left-pane merge="replace">true</always-open-left-pane>
</portal>
</server>

• Process Portal

Performance issues when a large task list populated with saved searches auto-refreshes

Change the default refresh period for a large task list that is populated with saved searches. The task list is updated whenever a task change occurs 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 numerous 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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <auto-refresh-delay merge="replace">100</auto-refresh-delay>
    </portal>
</server>

• Process Portal

Localization resources and language support

Define the list of locales that the system can use. For each language that you want to be supported for your process application, you create a file of key-value pairs for the strings that are displayed in the application.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <available-locales merge="replace">en-gb,en-au,es-co</available-locales>
    </portal>
</server>

• Process Portal

Order of dashboards

Change the default order of dashboards for all users. Unless default-start-page is configured or theProcess Portal user customized the order, dashboards in Process Portal are shown in the following default order, with the Work dashboard being displayed as the start page.

• 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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <default-dashboard-display-order merge="replace">Work</default-dashboard-display-order>
    </portal>
</server>

• Process Portal

Task details displayed in expanded task rows

Display all the available task details in task rows that are expanded by default.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <default-expand-task-data merge="replace">false</default-expand-task-data>
    </portal>
</server>

• Process Portal

Next Task dashboard

Use default-next-task-saved-search to define which tasks the dashboard shows. The Next Task dashboard is presented in Dashboards in Process Portal.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <show-next-task-dashboard merge="replace">false</show-next-task-dashboard>
        <default-next-task-saved-search merge="replace">MySavedSearch</default-next-task-saved-search>
        <return-task-to-team-on-logout merge="replace">tw_admins1,tw_admins2</return-task-to-team-on-logout>
    </portal>
</server>

See also return-task-to-team-on-logout and show-next-task-dashboard.

• Process Portal

Order of dashboards

Change the default start page for the Process Portal dashboards.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <default-start-page merge="replace">/tasks/queries?query=query_name</default-start-page>
    </portal>
</server>

See also default-dashboard-display-order.

• Process Portal

Task-list format

Change the display format of the tasks in the Work dashboard, which can be either a list or a table. By default, the tasks are displayed in a list.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <default-task-list-view merge="replace">list</default-task-list-view>
    </portal>
</server>

• Process Portal

Refresh behavior: CometD in single Business Automation Workflow environments

Change the CometD behavior. Process Portal uses CometD web messaging to push notifications and data refreshes to users when tasks and processes are updated on the server. In single Business Automation Workflow environments, CometD is enabled by default. 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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <disable-comet-d merge="replace">true</disable-comet-d>
        <disable-task-auto-refresh merge="replace">true</disable-task-auto-refresh>
    </portal>
</server>

For single Business Automation Workflow environments, see also disable-task-auto-refresh.
For federated Business Automation Workflow environments, seefederated-refresh-interval.

• Process Portal

Browser behavior for opening tasks

Disable the capacity to open tasks, dashboards (including the Work dashboard), and startable services in new windows, both at system and user preference levels. By default, tasks are opened in the Process Portal browser window. When set, this property overrides both the user preference and the open-task-in-new-window property, which applies to all users in the system.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <open-task-in-new-window merge="replace">true</open-task-in-new-window>
        <disable-open-in-new-window merge="replace">true</disable-open-in-new-window>
    </portal>
</server>

See also open-task-in-new-window.

• Process Portal

Configuration of social features

Configure the social features that you include in Process Portal, such as Following, Mentions, Experts, and Stream. Depending on your business requirements, you might want to disable some or all the social features. By default, all social features are enabled.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <disable-social merge="replace">following</disable-social>
    </portal>
</server>

• Process Portal

Refresh behavior: CometD in single Business Automation Workflow environments

Change the CometD behavior. Process Portal uses CometD web messaging to push notifications and data refreshes to users when tasks and processes are updated on the server. In single Business Automation Workflow environments, CometD is enabled by default. 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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <disable-comet-d merge="replace">true</disable-comet-d>
        <disable-task-auto-refresh merge="replace">true</disable-task-auto-refresh>
    </portal>
</server>

For single Business Automation Workflow environments, see also disable-comet-d.
For federated Business Automation Workflow environments, see federated-refresh-interval.

• Process Portal

Time tracking for experts

Include time tracking for experienced users in the Experts tab in Process Portal. 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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <display-time-tracking merge="replace">true</display-time-tracking>
    </portal>
</server>

• Process Portal

HTML frame support

Enable running Process Portal in an HTML frame.

Due to security constraints, login pages and index pages cannot be displayed in an HTML frame by default; otherwise, these pages automatically redirect the browser to display the page itself instead of the frame. However, you might need to display Process Portal pages inside HTML frames. For example, your team might want to view Process Portal data inside a customer user interface.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <enable-run-in-frame merge="replace">true</enable-run-in-frame>
    </portal>
</server>

• Process Portal

Performance issues at logon

Improve performance of users who belong to multiple user groups when they log on to Process Portal. Use this property to omit group membership retrieval from REST API calls.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <exclude-membership-info-from-user-info-rest-apis merge="replace">true</exclude-membership-info-from-user-info-rest-apis>
    </portal>
</server>

Note that when you set this property, the Work dashboard cannot automatically refresh because membership information is not available. Ensure that you also disable the automatic refresh custom properties disable-comet-d, disable-task-auto-refresh, and federated-refresh-interval.
The following custom properties are unaffected: restrict-modify-task, restrict-modify-task-reassign, restrict-modify-task-due, restrict-modify-task-priority, and hide-work-dashboard.

• Process Portal

Performance issues with snapshots in the Launch and Dashboards lists

Improve the Process Portal performance by excluding references to items from process application snapshots, thus limiting the exposed items to those that come from the toolkit only.

The items in the Launch and Dashboards lists can have multiple snapshots. Each process application snapshot can also refer to toolkits, which in turn, refer to exposed items by type or service subtype. These references can lead to multiple entries in the list for the same exposed item: an entry that comes from the toolkit and an entry from each process application that refers to the toolkit.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <exclude-referenced-from-toolkit merge="replace">startable_service</exclude-referenced-from-toolkit>
    </portal>
</server>

• Process Portal

Refresh behavior in federated Business Automation Workflow environments

Control how often the content in Process Portal is refreshed with content from the Process Federation Server. CometD is not available in federated environments. By default, the value of the property is 60 seconds. To disable automatic refreshing, set the value of the property to 0 (zero).

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <federated-refresh-interval merge="replace">60</federated-refresh-interval>
    </portal>
</server>

For single Business Automation Workflow environments, see disable-comet-d and disable-task-auto-refresh.

• Process Portal

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <hide-processes-dashboard merge="replace">tw_admins1,tw_admins2</hide-processes-dashboard>
    </portal>
</server>

• Process Portal

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <hide-process-performance-dashboard merge="replace">tw_admins1,tw_admins2</hide-process-performance-dashboard>
    </portal>
</server>

• Process Portal

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <hide-team-performance-dashboard merge="replace">tw_admins1,tw_admins2</hide-team-performance-dashboard>
    </portal>
</server>

• Process Portal

Work dashboard

Hide the default Process Portal dashboard from specific security groups. Instead of using the default Work dashboard, you might want to provide some or all Process Portal users with a custom Work dashboard instead.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <hide-work-dashboard merge="replace">tw_admins1,tw_admins2</hide-work-dashboard>
    </portal>
</server>

• Process Portal

Monitoring inactivity

Extend the timeout warning interval to a more appropriate value, beyond the default two-minute mark. Note that the value of inactivity-modal-timeout-in-seconds must be less than the value of inactivity-threshold-in-seconds.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <inactivity-modal-timeout-in-seconds merge="replace">180</inactivity-modal-timeout-in-seconds>   
    </portal>
</server>

See also inactivity-monitor, inactivity-threshold-in-seconds, and inactivity-stop-monitor-when-open-in-new-window.

• Process Portal

Monitoring inactivity

Fully enable the inactivity monitoring service by setting inactivity-monitor and inactivity-threshold-in-seconds to some valid values.

You can set an inactivity timeout on individual users' Process Portal sessions. If a user stops interacting with Process Portal without logging out, inactivity is detected after the predefined timeout threshold is reached. Process Portal automatically logs out the user system-wide.

For inactivity-monitor and inactivity-threshold-in-seconds to monitor the user interaction with a coach, the is-sending-activity-messages property must be set.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <inactivity-monitor merge="replace">true</inactivity-monitor>
        <inactivity-threshold-in-seconds merge="replace">300</inactivity-threshold-in-seconds>
        <inactivity-stop-monitor-when-open-in-new-window merge="replace">true</inactivity-stop-monitor-when-open-in-new-window>
    </portal>
    <coach-generation-config merge="mergeChildren">
        <is-sending-activity-messages merge="replace">true</is-sending-activity-messages>
    </coach-generation-config>
</server>

See also inactivity-modal-timeout-in-seconds, inactivity-threshold-in-seconds, and inactivity-stop-monitor-when-open-in-new-window.

• Process Portal

Monitoring inactivity

Determine whether the idle timeout monitor must be stopped when a task is opened in new window.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <inactivity-monitor merge="replace">true</inactivity-monitor>
        <inactivity-threshold-in-seconds merge="replace">300</inactivity-threshold-in-seconds>
        <inactivity-stop-monitor-when-open-in-new-window merge="replace">true</inactivity-stop-monitor-when-open-in-new-window>
    </portal>
    <coach-generation-config merge="mergeChildren">
        <is-sending-activity-messages merge="replace">true</is-sending-activity-messages>
    </coach-generation-config>
</server>

See also inactivity-modal-timeout-in-seconds, inactivity-monitor, and inactivity-threshold-in-seconds.

• Process Portal

Monitoring inactivity

Fully enable the inactivity monitoring service by setting inactivity-monitor and inactivity-threshold-in-seconds to some valid values.

You can set an inactivity timeout on individual users' Process Portal sessions. If a user stops interacting with Process Portal without logging out, inactivity is detected after the predefined timeout threshold is reached. Process Portal automatically logs out the user system-wide.

For inactivity-monitor and inactivity-threshold-in-seconds to monitor the user interaction with a coach, the is-sending-activity-messages property must be set.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <inactivity-monitor merge="replace">true</inactivity-monitor>
        <inactivity-threshold-in-seconds merge="replace">300</inactivity-threshold-in-seconds>
        <inactivity-stop-monitor-when-open-in-new-window merge="replace">true</inactivity-stop-monitor-when-open-in-new-window>
    </portal>
    <coach-generation-config merge="mergeChildren">
        <is-sending-activity-messages merge="replace">true</is-sending-activity-messages>
    </coach-generation-config>
</server>

See also inactivity-modal-timeout-in-seconds, inactivity-monitor, and inactivity-stop-monitor-when-open-in-new-window.

• Process Portal

Monitoring inactivity

Enable inactivity-monitor and inactivity-threshold-in-seconds to monitor the user interaction with a coach.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <inactivity-monitor merge="replace">true</inactivity-monitor>
        <inactivity-threshold-in-seconds merge="replace">300</inactivity-threshold-in-seconds>
        <inactivity-stop-monitor-when-open-in-new-window merge="replace">true</inactivity-stop-monitor-when-open-in-new-window>
    </portal>
    <coach-generation-config merge="mergeChildren">
        <is-sending-activity-messages merge="replace">true</is-sending-activity-messages>
    </coach-generation-config>
</server>

• Process Portal

Refresh behavior: access to large numbers of saved searches

Optimize how long lists of saved searches are loaded in the Work dashboard. This property works in conjunction with the incremental and full values of the launch-list-show-more-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.

The default values are suitable in most cases, but administrators can change them when necessary.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <launch-list-show-more-strategy merge="replace">incremental</launch-list-show-more-strategy>
        <launch-list-show-more-count merge="replace">10</launch-list-show-more-count>
    </portal>
</server>

See also launch-list-show-more-strategy.

• Process Portal

Refresh behavior: access to large numbers of saved searches

Optimize how long lists of saved searches are loaded in the Work dashboard. This 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 (default value): Each Show More click 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.
• full: Loads the complete list of elements to display when the user clicks Show More.
• preload: 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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <launch-list-show-more-strategy merge="replace">incremental</launch-list-show-more-strategy>
        <launch-list-show-more-count merge="replace">10</launch-list-show-more-count>
    </portal>
</server>

See also launch-list-show-more-strategy.

• oauth-reauth-allowed
• oauth-reauth-logout-
  timeout-in-seconds
• oauth-reauth-logout-
  timeout-in-seconds-
  while-reauth

• Process Portal

• com.ibm.bpm.oauth.reauth.
  allowed
• com.ibm.bpm.oauth.reauth.
  logoutTimeoutInSeconds
• com.ibm.bpm.oauth.reauth.
  logoutTimeoutInSeconds
  WhileReauth

OAuth support for re-authentication

Enable support for re-authentication.

• oauth-reauth-allowed: Allow users to re-authenticate after a session timeout.
• oauth-reauth-logout-timeout-in-seconds: 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.
• oauth-reauth-logout-timeout-in-seconds-while-reauth: Set the timeout, in seconds, before users are logged out after they started the re-authentication process. The default value is 120 seconds.

If you configure IBM® Process Federation Server or Process Portal with User Management Service and OAuth, these properties are set accordingly. For more information, see Configuring single sign-on.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <oauth-reauth-allowed merge="replace">true</oauth-reauth-allowed>
        <oauth-reauth-logout-timeout-in-seconds merge="replace">60</oauth-reauth-logout-timeout-in-seconds>
        <oauth-reauth-logout-timeout-in-seconds-while-reauth merge="replace">120</oauth-reauth-logout-timeout-in-seconds-while-reauth>
    </portal>
</server>

• Process Portal

Browser behavior for opening tasks

Get tasks to open in a new browser window. Process Portal users can change the behavior in their user profiles so that tasks open in Process Portal window (default behavior). 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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <open-task-in-new-window merge="replace">true</open-task-in-new-window>
        <disable-open-in-new-window merge="replace">true</disable-open-in-new-window>
    </portal>
</server>

See also disable-open-in-new-window.

• restrict-modify-task
• restrict-modify-task-
  due
• restrict-modify-task-
  priority
• restrict-modify-task-
  reassign

• Process Portal

Role-based task actions

Action policies determine the authorization for actions in Process Portal. Based on user roles, restrict-modify-task 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 other restrict properties:

• restrict-modify-task-due: Determines who can see the due date fields.
• restrict-modify-task-priority: Determines who can see the priority field.
• restrict-modify-task-reassign: Determines who can see the reassign actions.

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.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <restrict-modify-task merge="replace">tw_admins1, tw_admins2</restrict-modify-task>
        <restrict-modify-task-reassign merge="replace">tw_admins1, tw_admins2</restrict-modify-task-reassign>
        <restrict-modify-task-due merge="replace">tw_admins1, tw_admins2</restrict-modify-task-due>
        <restrict-modify-task-priority merge="replace">tw_admins1, tw_admins2</restrict-modify-task-priority>
    </portal>
</server>

• Process Portal

Performance issues when data is loaded with Show More buttons

Allow long-running REST requests time to complete by setting the value of this property to an integer that corresponds to the number of seconds for the timeout. Process Portal uses REST requests to retrieve displayed data. While most requests complete successfully, some might take longer due to various factors, such as the amount of data to be retrieved, server and database latency, and network latency. So, for example, you might see a timeout error message when you click Show More either on the task list in the Work dashboard or on the instance list in the Processes dashboard.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <rest-request-timeout-seconds merge="replace">60</rest-request-timeout-seconds>
    </portal>
</server>

• Process Portal

Next Task dashboard

Use return-task-to-team-on-logout to define what happens when users log out. The Next Task dashboard is presented in Dashboards in Process Portal.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <show-next-task-dashboard merge="replace">false</show-next-task-dashboard>
        <default-next-task-saved-search merge="replace">MySavedSearch</default-next-task-saved-search>
        <return-task-to-team-on-logout merge="replace">tw_admins1,tw_admins2</return-task-to-team-on-logout>
    </portal>
</server>

See also default-next-task-saved-search and show-next-task-dashboard.

• Process Portal

Shared saved searches

Use saved-search-hide-everyone to hide Everyone from the team list to prevent sharing a saved search with every user.

<server merge="mergeChildren"> 
<portal merge="mergeChildren"> 
<saved-search-hide-everyone merge="replace">true</saved-search-hide-everyone> 
</portal> 
</server>

• Process Portal

Filter saved search results

Use saved-search-mandatory-criteria to add mandatory criteria to filter your saved search results. The property uses a comma-separated list of filter names. Optionally, you can also add operators. As an example, to make the Process app acronym filter with the Contains operator mandatory, use the input instanceProcessApp:Contains.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <saved-search-mandatory-criteria merge="replace">instanceProcessApp:Contains,Priority</saved-search-mandatory-criteria>
    </portal>
</server>

• Process Portal

Next Task dashboard

Use show-next-task-dashboard to control whether the Next Task dashboard is shown and to what users. The Next Task dashboard is presented in Dashboards in Process Portal.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <show-next-task-dashboard merge="replace">false</show-next-task-dashboard>
        <default-next-task-saved-search merge="replace">MySavedSearch</default-next-task-saved-search>
        <return-task-to-team-on-logout merge="replace">tw_admins1,tw_admins2</return-task-to-team-on-logout>
    </portal>
</server>

See also default-next-task-saved-search and return-task-to-team-on-logout.

• Process Portal

File type restrictions for stream attachments

Restrict the file types that you can add to the stream through a comma-separated list of file extensions. For example: exe,jar,zip. By default, you can add any file types to the stream.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <stream-attachments-extensions-blacklist merge="replace">exe,jar,zip</stream-attachments-extensions-blacklist>
    </portal>
</server>

• task-filter-service-
  always-run
• task-filter-service-
  name
• task-filter-service-
  show-toggle

• Process Portal

• com.ibm.bpm.portal.task.
  filter.service.alwaysRun
• com.ibm.bpm.portal.task.
  filter.service.name
• com.ibm.bpm.portal.task.
  filter.service.showToggle

Task filter service for custom sorting and filtering of saved search results

Enable and configure the task filter service to gain programmatic control over the sorting and filtering of your task list.

• task-filter-service-always-run: Call the task filter service after every saved search execution.
• task-filter-service-name: The name of the task filter service, in the <project-acronym>@<service-name> format. For example, SYSRP@Task Filter Service.
• task-filter-service-show-toggle: Show or hide the task filter service toggle to the user.

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <task-filter-service-name merge="replace">MYPA@FILTER_SERVICE</task-filter-service-name>
        <task-filter-service-always-run merge="replace">true</task-filter-service-always-run>
        <task-filter-service-show-toggle merge="replace">true</task-filter-service-show-toggle>
    </portal>
</server

See also Prioritizing work.

• Process Portal

Support for resumable services

For a resumable service, enable this property to reuse service instances in Process Portal if they are still available in the user's session memory.

When a human service, such as a dashboard, is started in Process Portal, the instance and its data remains in the user's session memory until the service ends, the user logs out, or the session times out.

By default, human services are not resumable. Therefore, when the user leaves a page, such as a dashboard page, the service instance stays in the user's session. If the user returns to the dashboard, a new service instance is created, which can use much server memory for each user.

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. For more information, see Enabling resumable services.

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

<server merge="mergeChildren">
    <portal merge="mergeChildren">
        <z-resumable merge="replace">MAILCOM</z-resumable>
    </portal>
</server>