The default trk_milestone.msg notification file uses the following WorkFlo Services 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 Web WorkFlo 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. The web server value is taken from the vwserver.ini file on the WorkFlo Services 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. Including [1] causes the Image Services user name to display in the notification. |
$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_WORKFLOW_DEADLINE |
String containing a computed value. The value represents the result of the following computation: F_StartTime + F_WFDeadline(*60). (The F_WFDeadline field contains the workflow deadline value, in minutes.) |
|
$F_MILESTONE_NAME |
|
String containing the name of the milestone, as it was defined in Designer, that was reached. |
$F_Text |
yes | String containing the text entered in the Message field, in Designer, when the the milestone was defined. Typically the string contains additional information about what the milestone notification means to the user who received it. |
Tip In addition to the default variables listed above, you can add optional variables in the notification file.
When shipped, the trk_milestone.msg file contained the following HTML formatting (the variables appear in bold text):
<$F_SUBJPREFIX Workflow Milestone Reached: >
<html>
<head>
<title>Workflow Tracker Milestone Notification</title>
</head>
<body background="http://<$F_WEBSERVER>/idmws/images/FN_Logo_Background.gif"
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>Deadline: </strong></td>
<td align="left"><$F_WORKFLOW_DEADLINE></td>
</tr>
</table>
<hr>
The Milestone, <$F_MILESTONE_NAME>, has been reached with the following
message: <$F_Text>
<hr>
</body>
</html>