Configuring custom properties for Process Portal by using the resource provider for mashups

To modify the default behavior of Process Portal or Heritage Process Portal for individual users or groups, administrators can use several mashups custom properties in the administrative console.

1. In the administrative console, go to Resources > Resource Environment > Resource Environment Providers > Mashups_ConfigService > Custom properties.
2. Add the appropriate custom property from the following tables.

   Table 1. Process Portal custom properties

   Runtime behavior	Custom properties
   Role-based task actions	Process Portal action policies determine the authorization for actions in Process Portal. For more information about action policies, see Configuration properties for Process Portal action policies. You can further restrict who can see task actions in Process Portal by using the following custom properties. 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 don't set a value for a property, everyone can see the action. com.ibm.bpm.portal.restrictModifyTask 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.
   Refresh behavior	Single IBM® BPM environments Process Portal uses CometD web messaging to push notifications and data refreshes to users when tasks and processes are updated on the server. Use the following custom properties to change the CometD behavior: com.ibm.bpm.portal.disableCometD 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.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. Federated IBM BPM environments CometD is not available in federated environments. To control how often the content in Process Portal is refreshed with content from the process federation server, use the following custom property: 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).
   The Following, Mentions, Experts, and Stream social features	Depending on your business requirements, you might want to disable some, or all, of the social features that Process Portal provides. To configure the social features that you include in Process Portal, use the following custom property: 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.
   Work dashboard	Instead of using the default Work dashboard, you might want to provide some or all of your Process Portal users with a custom Work dashboard instead. To hide the default dashboard from specific security groups, use the following custom property: 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.
   Default start page	The Work dashboard is the default start page for Process Portal. To change the default page, use the following custom property: 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 /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.
   Order of the dashboards	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 To change the order of the dashboards for all users, use the following custom property: com.ibm.bpm.portal.defaultDashboardDisplayOrder 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.
   Task-list format	You can display tasks in the Work dashboard in a list or a table. By default, the tasks are displayed in a list. To change the default format, use the following custom property: com.ibm.bpm.portal.defaultTaskListView You can set the property to one of the following values: list, table.
   Browser behavior for opening tasks	By default, tasks are opened in the Process Portal browser window. To configure browser behavior, use the following custom property: 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 don't 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 based on an external implementation, it always opens in a new browser window regardless of the value of this custom property.
   File type restrictions for stream attachments (Process Portal and Heritage Process Portal)	By default you can add files of any file type to the stream. To restrict the file types that can be added to the stream, use the following custom property: 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.
   Time-tracking data for experts (Process Portal and Heritage Process Portal)	You can 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. To enable tracking data, use the following custom property: com.ibm.bpm.portal.displayTimeTracking Set the value of the property to true.
   Support for resumable services (Process Portal and Heritage Process Portal)	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 a lot of server memory for each user. When a service is resumable, you must also enable the following custom property to reuse service instances in Process Portal if they are still available in the user’s session memory. com.ibm.bpm.social.zResumable 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.
   HTML frame support (Process Portal and Heritage Process Portal)	Because of 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. To enable HTML frame support, use the following custom property: com.ibm.bpm.social.enableRunInFrame To run Process Portal in an HTML frame, set the value to true.
   Performance issues at logon (Process Portal and Heritage Process Portal)	When users belong to many user groups, they might experience performance issues when they log onto Process Portal. To improve performance for these users, you can omit group membership retrieval from REST API calls. To omit group membership information, use the following custom property: 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
   Performance issues when loading data with Show More buttons (Process Portal and Heritage Process Portal)	Process Portal uses REST requests to retrieve displayed data. While most requests complete successfully, some might take longer because of 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. To allow long-running REST requests time to complete, you can configure the REST timeout value by using the following custom property: com.ibm.bpm.social.restRequestTimeoutSeconds Set the value of the property to an integer that corresponds to the number of seconds for the timeout.
   Performance issues with snapshots in the Launch and Dashboards lists (Process Portal and Heritage Process Portal)	The items in the Launch and Dashboards lists can have multiple snapshots. Each of these process application snapshots 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. The multiple references can also impact Process Portal performance. To limit the exposed items to those that come from the toolkit only, use the following property: 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.
   Content loading in a new browser window (Process Portal)	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. You might see about:blank in the address bar until the coach loads. To avoid this unwanted behavior, configure the com.ibm.bpm.social.enableDeferNewWindowOpen 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.
   Localization resources and language support	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. 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 See also Creating localization resources.

   Table 2. Heritage Process Portal custom properties

   Runtime behavior	Custom properties
   Task-level collaboration	Task-level, user-to-user collaboration enables one or more users to work directly on a task in Heritage Process Portal. However, this type of collaboration can result in tasks that are unintentionally locked. To disable task-level collaboration, use the following custom property: 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.
   HTML tags in stream comments	By default, only b and span HTML tags are allowed in comments in the Stream tab. To enable further HTML tags to be used, use the following custom property com.ibm.bpm.portal.streamTags Set the value to a comma separated list of HTML tags, for example br,p,sup.
   Browser behavior for opening dashboards	You can adjust the Heritage Process Portal browser behavior for opening dashboards, for example, to correctly display larger dashboards or dashboards that include heritage coaches. To enable dashboards to open in new browser windows, use the following custom property: 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. Attention: The custom property applies only to dashboards in the Dashboards list and not to processes and services in the Launch list.
   Error message pop-ups	When an error occurs in Process Portal, you might see a pop-up window that includes a plus (+) icon button. You can click the button to get more information about the message, which might include a stack trace. The detailed error information might not be suitable for all Process Portal users. To prevent the additional information from being displayed, use the following custom property: com.ibm.bpm.social.hideDetailsInErrorDialog To hide the plus (+) icon and the error details, set the value to true.
   Accessible hover help	By default, you can't use the keyboard to tab to hover help text for icons and labels in Heritage Process Portal. To enable keyboard accessibility, use the following custom property: 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.