The default org_milestone.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 a user when a workflow is started. |
$F_Originator[1] | yes | Integer containing the user ID of the participant who 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_MILESTONE_NAME | String containing the name of the milestone that was reached. This name is the name of the milestone as it was defined in Process Designer. | |
$F_Text | yes | String containing the text that is entered in the Message field, in Process Designer, when the milestone is 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 that is assigned when the workflow is 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. |
In addition to the default variables listed above, you can add optional variables in the notification file.
When shipped, the org_milestone.msg file contained the following HTML formatting (the 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 Workflow Milestone Reached: >
<title>Workflow Milestone 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>Deadline: </strong></td>
<td align="left"><$F_TimeStamp></td>
</tr>
</table>
<hr>
<p>
<font color="#FF0000">
The Milestone, <$F_MILESTONE_NAME>, has been reached with the following message:<br>
<$F_Text>
</font>
</p>
<table>
<tr>
<td align="center">
<img border="0" src="http://<$F_WEBSERVER>/"/images/type/Users16.gif" width="16" height="16">
</td>
<td>
<a href="#" OnClick = "window.open('http://<$F_WEBSERVER>/"/eprocess/WcmMilestones.jsp?
workflowNumber=<$F_WorkFlowNumber>&workSpaceId=<$F_WorkSpaceId>&workClassId=<$F_WorkClassId>')">Milestones ...</a>
</td>
</tr>
</table>
<hr>
</body>
</html>