Get Started!

˂ Return to FAQ

How to Customize the Email Notification Templates

If you wish to customize the default email templates that are used for notifications, please perform the following steps.

1

Login to the XTAM host computer and copy the “templates” directory from here $XTAM_HOME/web/webapps/xtam/ to here $XTAM_HOME/content/.

Please note that the target location $XTAM_HOME/content/ is defined in Administration > Settings > Parameters > Content Location and may differ depending on your configuration.

2

Only modify the html files, the *.script files are unrelated to email templates and should not be altered. We recommend you test your updates using the “email_test.html” template as this is only sent when using the Test Email option in the Mail Server configuration. Save and close each when you are done.

3

That’s it! Trigger an action that causes an email notification (i.e. Test Email in the Mail Server configuration) in your system to test your new templates.

 

Email Template Placeholders

The following placeholders are available to be used in your email templates to dynamically populate values in your recipient message bodies.

General Placeholders

Placeholder Description
{{alert.reason}} Displays the value from the alert’s Message field.
{{item.description}} Displays the value from the item’s Description field.
{{item.id}} Displays the item’s ID.
{{item.name}} Displays the value from the item’s Name field.
{{item.type}} Displays the value from the item’s Type.
{{item.url}} Displays the URL to the item.
{{log.category}} Displays the value from the Audit Log’s Category field.
{{log.created}} Displays the value from the Audit Log’s Time field.
{{log.event}} Displays the value from the Audit Log’s Event field.
{{log.level}} Displays the value from the Audit Log’s Level field.
{{log.message}} Displays the value from the Audit Log’s Message field.
{{log.object.name}} Displays the value from the Audit Log’s Object field.
{{log.object.type}} Displays the value from the Audit Log’s Type field (hidden).
{{log.user.displayName}} Displays the first and last name value from the Audit Log’s User field.
{{log.user.firstName}} Displays the first name value from the Audit Log’s User field.
{{log.user.lastName}} Displays the last name value from the Audit Log’s User field.
{{log.user.login}} Displays the login value from the Audit Log’s User field.
{{managed.path}} Displays the value from XTAM’s Managed Path field. Useful for properly constructing URLs.
{{user.displayName}} Displays the first and last name of the user which the action was taken for or applied to. For example, a record that was shared with this user.
{{user.firstName}} Displays the first name of the user which the action was taken for or applied to. For example, a record that was shared with this user.
{{user.lastName}} Displays the last name of the user which the action was taken for or applied to. For example, a record that was shared with this user.
{{user.login}} Displays the login name of the user which the action was taken for or applied to. For example, a record that was shared with this user.

Report Placeholders

Placeholder Description
{{report.mediaType}} Displays the format in which the report is generated (CSV or PDF).
{{report.period}} Displays the time period for which the report covers (Daily, Weekly or Monthly).
{{report.type}} Displays the type of the report (Audit, Inventory, Job History, etc).

Workflow Placeholders

Placeholder Description
{{request.action}} Displays the action that was requested using the workflow.
{{request.created}} Displays the timestamp of when the request was made using the workflow.
{{request.id}} Displays the request ID of this workflow.
{{request.reason}} Displays the value that was entered into the Reason field when initiating the request.
{{request.requester.displayName}} Displays the first and last name of the user that initiated the request or with whom it was granted on behalf of.
{{request.requester.firstName}} Displays the first name of the user that initiated the request or with whom it was granted on behalf of.
{{request.requester.lastName}} Displays the last name of the user that initiated the request or with whom it was granted on behalf of.
{{request.requester.login}} Displays the login name of the user that initiated the request or with whom it was granted on behalf of.
{{request.status}} Displays the value from the workflow’s Status field.

 
 

Copyright © 2019 Xton Technologies, LLC. All rights reserved.