The default org_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. 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 WorkFlo Services server. |
$F_Subject |
yes |
String containing the subject entered by a user when a workflow was launched. |
$F_Originator[1] |
yes |
Integer containing the user ID of the participant who 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_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. |
$F_WorkSpaceId |
yes |
String containing the workspace ID value assigned when the workflow was first transferred. |
$F_WorkClassId |
yes |
String containing a representation of the workflow number. |
$F_WorkFlowNumber |
yes | GUID (Global Unique IDentifier). The GUID identifies the unique instance of the active workflow. |
Tip In addition to the default variables listed above, you can add optional variables in the notification file.
The JavaScript included in the message constructs a unique request for the VWProcess object necessary to fetch the milestone array containing this milestone. The script passes the exposed field data to the milestone.asp file, on the Web WorkFlo server, to display a list of the milestones.
When shipped, the org_milestone.msg file contained the following HTML formatting (the variables appear in bold text):
<$F_SUBJPREFIX Workflow
Milestone Reached: >
<html>
<head>
<title>Workflow Milestone Notification</title>
<SCRIPT language="JavaScript" src="http://<$F_WEBSERVER>/idmws/Redist/WF_Html_Toolkit/Utility/utility.js"></script>
<SCRIPT language="JavaScript">
<!--
function onOpenMilestones(webServer, workSpaceID, workClassId, workflowNumber,
subject, launchDate)
{
var subjectURL = convertToSpecialChar(subject);
var launchDateURL = convertToSpecialChar(launchDate);
window.open("http://" + webServer +"/idmws/PWRedirector.asp?Redist/WF_Milestone/milestone.asp?workSpaceId="
+ workSpaceID +"&workClassId=" + workClassId + "&workflowNumber="
+ workflowNumber + "&subject=" +subjectURL +"&launchDate="
+ launchDateURL);
}
//-->
</SCRIPT>
</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>
</table>
<hr>
The Milestone, <$F_MILESTONE_NAME>,
has been reached with the following message: <$F_Text>
<hr>
<table>
<tr>
<td align="center">
<img border="0" src="http://<$F_WEBSERVER>/idmws/images/milestone.gif"
width="32" height="32">
</td>
<td>
<a href="#" OnClick="JavaScript:onOpenMilestones('<$F_WEBSERVER>',
'<$F_WorkSpaceId>',
'<$F_WorkClassId>', '<$F_WorkFlowNumber>',
<$F_Subject>, <$F_StartTime>)">Milestone Tracking...</a>
</td>
</tr>
</table>
</body>
</html>