The default stp_new.msg notification file uses the listed workflow system variables. Some notification information is taken from the exposed log fields. If you disable the fields, you cannot use the field values in the notification. All field variables are case-sensitive.
Field variable | Exposed | Description |
---|---|---|
$F_SUBJPREFIX | String containing the prefix for the subject line of the notification message. | |
$F_WEBSERVER | String containing the name of the Application Engine server that a participant must attach to in order to respond to the notice. The name is also used to supply the background and notification type images. Additionally, the string is used to construct the URL for a step item. The $F_WEBSERVER value is retrieved from the Web Applications Server Base URL setting for the workflow system or isolated region. The isolated region value overrides the workflow system value. | |
$F_Subject | yes | String containing the subject that is entered by the user when a workflow is started. |
$F_Originator[1] | yes | Integer containing the user ID of the participant that started the workflow. |
$F_StartTime | yes | String containing the time that the workflow was created. Except for the initial work item of the workflow, it is different from the $F_CreateTime value. |
$F_TimeStamp | yes | String containing the time the step assignment occurred. |
$F_STEPLABEL | String containing the step label from the workflow definition. | |
$F_STEPINSTR | String containing the step instructions from the workflow definition. | |
$F_STEPPROC | String specifying the processor that the participant must use to complete the step. | |
$F_WORKQUEUE | String containing the work queue that is associated with the step or work item. | |
$F_WobNum | yes | GUID (Global Unique IDentifier). The GUID identifies the specific work item for the notification. |
In addition to these default variables, you can add optional variables in the notification file.
The shipped stp_new.msg file contains the following HTML formatting (variables appear in bold text):
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<$F_SUBJPREFIX Work Item: >
<title>Step Assignment Notification</title>
</head>
<body bgcolor="#FFFFFF" link="#6666FF" vlink="#C0C0C0" alink="#6666FF">
<table border="0">
<tr>
<td align="left"><strong>Subject: </strong></td>
<td align="left"><$F_Subject></td>
</tr>
<tr>
<td align="left"><strong>Launched By: </strong></td>
<td align="left"><$F_Originator[1]></td>
</tr>
<tr>
<td align="left"><strong>Launched On: </strong></td>
<td align="left"><$F_StartTime></td>
</tr>
<tr>
<td align="left"><strong>Received On: </strong></td>
<td align="left"><$F_TimeStamp></td>
</tr>
<tr>
<td align="left"><strong>Step Label: </strong></td>
<td align="left"><$F_STEPLABEL> </td>
</tr>
<tr>
<td align="left"><strong>Instructions: </strong></td>
<td align="left"><$F_STEPINSTR></td>
</tr>
</table>
<hr>
<table>
<tr>
<td align="center">
<img border="0" src="http://<$F_WEBSERVER>/"/images/type/QueueElement16.gif" width="16" height="16">
</td>
<td>
<a href="#" OnClick = "window.open('http://<$F_WEBSERVER>/"/eprocess/stepprocs/<$F_STEPPROC>?
queueName=<$F_WORKQUEUE>&wobNum=<$F_WobNum>')">Step Assignment...
</a>
</td>
</tr>
</table>
<hr>
</body>
</html>