The default stp_new.msg notification file uses the listed Process Engine variables. Some notification information is taken from the exposed log fields; if you disable the fields, you will not be able to 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 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 web server value is taken from the vwserver.ini file on the Process Engine server. |
$F_Subject |
yes |
String containing the subject entered by the user when a workflow was launched. |
$F_Originator[1] |
yes |
Integer containing the user ID of the participant that started the workflow. |
$F_StartTime |
yes |
String containing the time the workflow was created. With the exception of the initial work item of the workflow, it is different than 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 the participant must use to complete the step. |
$F_WORKQUEUE |
|
String containing the work queue 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 the default variables listed above, you can add optional variables in the notification file.
When shipped, the stp_new.msg file contained the following HTML formatting (the variables appear in bold text):
<$F_SUBJPREFIX Work Item: >
<html>
<head>
<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>