Customizing the content of notifications

The Notification Template area is a rich text editor that enables you to generate HTML for the email notification messages. It provides font and paragraph formatting options, which are found below the Notification Template box. The options include font type, size, style, and color, as well as paragraph alignment and bullets.

For Task Notifications only, Process Management includes two predefined URL configurations that you can drag from the Url Generation list into the Notification Template box and then customize:

• OpenTask is available for the Reminder and Task Assignment notification types. This URL provides a link to the task in Workspace, allowing the user to access the task quickly from the email notification. When you drag the OpenTask URL to the Notification Template box, the URL is in the following format:

  http://@@notification-host@@:<PORT>/workpace/Main.html?taskId=@@taskid@@

• ClaimTask is available for the Group - Reminder and Group - Task Assignment notification types. This URL provides a link to the task details page in Workspace, where the user can either claim or claim and open the work item. When you drag the ClaimTask URL to the Notification Template box, the URL is in the following format:

  http://@@notification-host@@:<PORT>/workpace/Main.html?taskId=@@taskid@@

If your solution is deployed in a clustered environment, replace @@notification-host@@ with the cluster address.

<PORT> is the port number of the HTTP listener for the application server. The default HTTP listener port for the supported application servers are as follows:

JBoss:

8080

Oracle WebLogic Server:

7001

IBM WebSphere:

9080

To make these URLs function correctly, replace <PORT> with the port number that is appropriate for your environment.

Note: If you are using a custom web application other than Forms to provide users with access to the tasks, you must instead use a URL format that is appropriate for your custom application.

The Variable Picker list provides useful variables that you can drag-and-drop into the Subject or Notification Template boxes. When you drop a variable in the Subject or Notification Template boxes, it changes to the actual process management variable name with two @ symbols on either side of it, for example, @@taskid@@.

For reminders, task assignments, and deadlines for users and groups, you can use the following variables in the Subject and Notification Template boxes:

@@description@@

The contents of the Description property, as defined in the user step (start point, Assign Task operation, or Assign Multiple Tasks operation) of the process in Workbench.

@@instructions@@

The contents of the Task Instructions property, as defined in the user step of the process in Workbench.

@@notification-host@@

The host name of the LiveCycle application server.

@@process-name@@

The name of the process.

@@operation-name@@

The name of the step.

@@taskid@@

The unique identifier for the current task.

@@actions@@

Produces a numbered list of valid routes (for example, Approve, Reject) that the recipient can click.

In addition, for group reminders, group task assignments and group deadlines, you can also use:

@@group-name@@

The name of the group that is assigned the work item.

Note: If a variable has no value, nothing is returned.

For stalled branches, you can use the following variables in the Subject and Notification Template boxes:

@@branch-id@@

The branch identifier.

@@process-id@@

The process instance identifier.

@@notification-host@@

The host name of the LiveCycle application server.

For stalled operations, you can use the following variables in the Subject and Notification Template boxes:

@@action-id@@

The operation identifier.

@@branch-id@@

The branch identifier.

@@process-id@@

The process instance identifier.

@@notification-host@@

The host name of the LiveCycle application server.

If you type the following text in the Subject box for Task Assignment notifications:

Please complete task @@taskid@@

The user receives an email message with the following subject if they are assigned task 376:

Please complete task 376

If you type the following text in the Notification Template box for Stalled Branch notifications:

Branch @@branch-id@@ has stalled! You have received this notification from @@notification-host@@.

The administrator receives an email message that contains the following content if the branch number is 4868 and the server name is ServerXYZ:

Branch 4868 has stalled! You have received this notification from ServerXYZ.