Configuring Process Portal notification and refresh behavior

Edit online

In non-federated environments, Process Portal uses CometD web messaging to push notifications and data refreshes to users when relevant events happen in the system. You can configure notification and refresh behavior by updating settings in the 100Custom.xml configuration file.

About this task

Important: The following information applies to both Heritage Process Portal (deprecated) and Process Portal.

Notifications

Process Portal users receive notifications when events occur that affect their work, for example, when new tasks are assigned to them or they are mentioned in posts. The following type settings in the <web-messaging-push> element control the notification behavior.

Table 1. Type settings for notification behavior
Type	Behavior when `enabled="true"`
`NOTIFY_TASK_RESOURCE_ASSIGNED`	Notifications are sent to users when tasks are assigned to them as individuals or when tasks are assigned to the team that they belong to.
`NOTIFY_TASK_COLLABORATION_INVITE`	Heritage Process Portal only. Users receive notifications when they are invited to attend a collaboration session.
`NOTIFY_PROCESS_COMMENT_TAGGED`	Notifications are sent to users who are mentioned in comments that are posted to process instances.

Refresh behavior

Web messaging refreshes task and activity data when changes to tasks and instances are detected on the server. The following type settings in the <web-messaging-push> element control the refresh behavior.

Table 2. Type settings for refresh behavior
Type	Behavior when `enabled="true"`
`TASKLIST_TASK_RESOURCE_ASSIGNED`	Task data in the Work dashboard, Team Performance dashboard, and the instance details UI is refreshed when a task is assigned to an individual or a group.
`TASKLIST_TASK_FIELD_CHANGED`	Task data in the Work dashboard, Team Performance dashboard, and the instance details UI is refreshed when a task is changed.

If either of these settings are disabled, Process Portal users must manually refresh the page that they are working with to get the latest task data. Refresh behavior is also affected by custom properties that can be set for Process Portal.

By default, all elements in the section are enabled. The parent <web-messaging-push> element determines whether CometD web messaging is enabled.

Important: If you disable CometD web messaging by setting enabled="false" on the parent <web-messaging-push> element, Process Portal is affected in the following ways:

No task data refreshes that are controlled by task list subscriptions occur, for example, the Work dashboard does not refresh.
No task assignment or post notifications are sent.
The user profile does not contain any notifications settings.

The following snippet from 100Custom.xml shows the settings that control both notification and refresh behavior.

<server>
   <web-messaging-push merge="replace" match="elementName" enabled="true">
      <web-messaging type="NOTIFY_TASK_RESOURCE_ASSIGNED" enabled="true"/>
      <web-messaging type="NOTIFY_TASK_COLLABORATION_INVITE" enabled="true"/>
      <web-messaging type="NOTIFY_PROCESS_COMMENT_TAGGED" enabled="true"/>
      <web-messaging type="TASKLIST_TASK_RESOURCE_ASSIGNED" enabled="true"/>
      <web-messaging type="TASKLIST_TASK_FIELD_CHANGED" enabled="true"/>
   </web-messaging-push>
</server>

For information about making and deploying 100Custom.xml configuration changes, see Creating a 100Custom.xml configuration file.