The Email Templates configuration allows users to edit HTML based templates, which are used by the Notifications and TaskTrack feature. These templates utilize placeholders to obtain data from the database.
A datafield can be used as a place holder in a template, if E-mail property is activated for it. Currently a user can customize existing templates for only five predefined events.
Custom placeholders can be defined by adding a property EmailTemplate_PlaceholderName within the Basic configuration page. The value of this property can then be addressed by using $PlaceholderName$ in the e-mail template.
The following predefined placeholders will be replaced with information from RayFlow:
Placeholder |
Supported Formats |
Function |
|---|---|---|
$CATEGORY$ |
Text |
Category name |
$DATA_FIELD$ |
Text or list |
List of all datafields with the enable Email property |
$EVENT$ |
Text |
Name of the event which was triggered |
$PACKAGE$ |
Text |
Task name (datafields mapped for ApplicationName type in report mapping or connection of all datafields with the visible property) |
$PACKAGE_ID$ |
Text |
Unique identifier of the active task |
$PROJECT$ |
Text |
Project name |
$RAYFLOW_LINK$ |
Text |
HTML link to the RayFlow base URL |
$RAYFLOW_PACKAGE_LINK$ |
Text |
Direct HTML link to the active package (only if logged into the RayFlow instance) |
$SCHEDULE$ |
Text |
SLA name |
$STATUS$ |
Text |
Active status name |
$TASK$ |
Text |
Active phase name |
$TASK_ID$ |
Text |
Unique identifier of the active phase |
$TASKTYPE$ |
Text |
Name of the task type. |
$USER$ |
Text |
Name of the user who made the change |
$VALUE$ |
Text or list |
Values which have been changed |
|
Note: The standard and the custom email placeholders can also be used in the Basic Configuration Message Settings subject term if the related email template subject terms are left blank. |
Editing an Email Template
To edit an e-mail template, click on the Edit this template icon. This will open the template in edit mode.
•The events are predefined
•The MESSAGE_EMAIL_SUBJECT property which is set in the Basic configuration is used to populate the subject field.
•The e-mail body can be created either in design or HTML mode
•To review the changes, before saving the changes made to the template, select the preview mode.
|
Be aware: Do not use placeholders which also support other formats than text (like $DATA_FIELD$ and $VALUE$) inside of the subject field! |
