Email Templates

>Adding Dynamic Content to Email Templates

New to Sentinel EMS?
See How to Use Sentinel EMS?

What are Email Templates?

An email template is a file that provides a predefined format and default content for the emails that are used to notify Sentinel EMS users. The following email templates are available in Sentinel EMS:

Template	Display Name	Description	Migrated TPL Files
LicenseCertificateReprint.emst	Reprint License Certificate	Email template that includes details of a license certificates for reprinting multiple activations.	N.A.
Resetpasswordemail.emst	Password Reset	Email template for notifying a user to reset the password.	ResetPassword.tpl
Productupgradeemail.emst	Product Upgrade	Email template for notifying users about a product upgrade. Sent after a product upgrade.	ProductUpgradeEmail.tpl
Licensecertificate.emst	License Certificate	Email template that includes details of a license certificate. Used for notifying a contact that a license was generated.	>LicenseCertificateEmail.tpl >LicenseCertificate12.tpl
Fitlicensecertificate.emst	Sentinel Fit License Certificate	Email template that includes details of a license certificate. Used for notifying a contact that a license was generated using Sentinel Fit enforcement.	>LicenseCertificateEmail.tpl >FitLicenseCertificate12.tpl
Fileloademail.emst	File Upload	Email template for notifying a user that a file was uploaded for an entity, along with information about the data imported.	>FileLoadEmail.tpl >FileLoadDetails.tpl
Entitlementnotactivatedemail.emst	Entitlements - Never Activated	Email template for notifying a user about entitlements that have never been activated.	EntitlementNotActivatedEmail.tpl
Entitlementexpiringemail.emst	Entitlements - Expiring Soon	Email template for notifying a user about entitlements that are about to expire. Specifies the number of days remaining.	EntitlementExpiringEmail.tpl
Entitlementexpiredemail.emst	Entitlements - Expired	Email template for notifying a user about entitlements that have recently expired. Lists the relevant entitlements.	EntitlementExpiredEmail.tpl
Entitlementdefaultemail.emst	New Entitlement - Notify User	Email template for notifying a user that an entitlement was created.	EntitlementDefaultEmail.tpl
Entitlementcertificate.emst	New Entitlement - Notify Contact	Email template that includes details of an entitlement certificate. Used for notifying a contact that an entitlement was generated.	>EntitlementCertificateEmail_LVH.tpl >EntitlementCertificate_LVH12.tpl >CertificateCldConnected_unNamed.tpl >CertificateCld_unNamed.tpl >EntitlementCertificate12.tpl > EntitlementCertificateEmail.tpl
Devicelicensecertificate.emst	License Certificate for Device	Email template that includes details of a license certificate for use on a specific device. Used for notifying a contact that a license was generated.	>LicenseCertificateEmail.tpl >LicenseCertificateDevice12.tpl
Contactcertificate.emst	Contact Creation Confirmation	Email template for notifying a user that a contact was created successfully.	>ContactCertificateEmail.tpl >ContactCertificate.tpl

NOTE In the table above the table, the Migrated TPL Files column lists the .tpl files of Sentinel EMS 5.0 that were migrated to the .emst files in Sentinel EMS 5.1.

Actions for Email Templates

The following table lists the actions available for email templates:

Action

Description

New

Creates a new email template.

To create an email template.

1.Click the New action to open the Add Email Template page.

2.Select the Template Language from the list of languages specified.

3.In the Configure Email Template Language Attributes section, use the available tools to modify the template. See Editing Email Templates for details of these tools.

4.Click Save.

Edit

Updates existing email template. See Editing Email Templates to understand how to edit an email template. Also see Adding Dynamic Content to Email Templates to understand how to add dynamic content to email templates.

Download

Downloads the email template.

Editing Email Templates

The Edit action opens an email template in the email template editor. You can use the tools available in the editor to modify and format the email template as required. The following table describes the email template editor tools:

Tools

Description

Undo

Erases the last change done to revert the email template to its previous state.

Redo

Restores the actions that have been previously undone using the Undo action.

Style

Various formatting styles defined by your theme.

Bold

Bolds the selected text.

Italic

Italicizes the selected text.

Underline

Underlines the selected text.

Text Color

Specifies or changes the font color. Click the arrow next to this tool and select a font color.

Background Color

Specifies or changes the background color. Click the arrow next to this tool and select a background color.

Align Left

Aligns the text to the left side of the page or the containing element.

Align Center

Aligns the text to the center of the page or the containing element.

Align Right

Aligns the text to the right side of the page or the containing element.

Justify

Alignment can only be applied to text and will align both sides of the text.

Bulleted List

Creates bullet points or bullet lists. Click the arrow next to this tool and specify the type of bullet.

Numbered List

Creates numbered points or numbered lists. Click the arrow next to this tool and select the numbering style.

Decrease Indent

Decreases the indentation space of the text or cursor from the margin on the left side of the page.

Increase Indent

Increases the indentation space of the text or cursor from the margin on the left side of the page.

Insert / Edit Link

Inserts or modifies a hyperlink.

To insert a hyperlink:

1.Click Insert / Edit Link to open the Insert / Edit Link dialog box.

2.Enter the URL, Text to Display, and Title.

3.Select Current Window or New Window to specify the window to open the target.

4.Click Save.

Insert / Edit Image

Inserts or modifies an image

To insert an image:

1.Click Insert / Edit Image to open the Insert / Edit Image dialog box.

2.Enter the Source, Image Description, Width, and Height of the image.

3.Click Save.

Table

Inserts a table. Also contains the tools that help to work with cells, rows, and columns in a table. The options in the table menu can also be accessed by right-clicking a selected table. Details of the tools to work with a table are given below:

Tools

Description

Table

Inserts a table based on the cell selection from the table grid.

Table Properties

Displays and allows you to update the following table properties:

General

>Width: The table width.

>Height: The table height.

>Cell Spacing: The distance between two cells.

>Cell Padding: The space between the text and the border of the cell.

>Border Width: The width of the table border.

>Show Caption: Specifies whether to display the table caption.

>Alignment: The alignment of the table as Left, Center, Right, or None.

Advanced

>Border Style: The border style as Solid, Dotted, Dashed, Double, Groove, Ridge, Inset, Outset, None, or Hidden.

>Border Color: The border color of the table.

>Background Color: The background color of the table.

Delete Table

Deletes the selected table.

Cell > Cell Properties

Displays and allows you to update the following cell properties:

General

>Width: The cell width.

>Height:The cell height.

>Cell Type: The type of cell as Cell or Header Cell.

>Scope: The scope of elements to which the properties will be applied. The scope can be specified as Row, Column, Row Group, Column Group, or None.

>Horizontal Alignment: The horizontal alignment of the text within the cell as Left, Center, Right, or None.

>Vertical Alignment: The vertical alignment of the text within the cell as Left, Center, Right, or None.

Advanced

>Border Style: The border style of the cell as Solid, Dotted, Dashed, Double, Groove, Ridge, Inset, Outset, None, or Hidden.

>Border Color: The border color of the cell.

>Background Color: The background color of the cell.

Cell > Merge

Merges the selected cells to one cell.

Cell > Split

Splits a single cell into two cells.

Row > Insert Row (Above)

Inserts new rows above the selected rows. The number of rows inserted is the same as the number of rows selected.

Row > Insert Row (Below)

Inserts new rows below the selected rows. The number of rows inserted is the same as the number of rows selected.

Row > Delete Row

Deletes the selected rows.

Row > Row Properties

Displays and allows you to update the following row properties:

General

>Row Type: The type of row as Header, Body, or Footer.

>Alignment: The alignment of the text within the row as Left, Center, Right, or None.

>Height: The height of the row.

Advanced

>Border Style: The border style of the row as Solid, Dotted, Dashed, Double, Groove, Ridge, Inset, Outset, None, or Hidden.

>Border Color: The border color of the row.

>Background Color: The background color of the row.

Row > Cut

Cuts the selected row and places it in the clipboard.

Row > Copy

Copies the selected row and places it in the clipboard.

Row > Paste (Above)

Pastes the content of the clipboard above the selected row.

Row > Paste (Below)

Pastes the content of the clipboard below the selected row.

Column > Insert Column (Left)

Inserts new columns to the left of the selected columns. The number of columns inserted is the same as the number of columns selected.

Column > Insert Column (Right)

Inserts new columns to the right of the selected columns. The number of columns inserted is the same as the number of columns selected.

Column > Delete Column

Deletes the selected column.

Source Code

Displays the HTML source code for the email template in the Source Code window. You can use this window to modify or format the email template using HTML elements.

Upload Template

Uploads an existing email template.

Save Template

Saves the changes made to the uploaded email template.

Adding Dynamic Content to Email Templates

The Sentinel EMS email templates are a combination of both static and dynamic data. The dynamic data is the information that changes and can be customized as required. You can use the JSON response of the Sentinel EMS REST APIs and simple knowledge of FreeMarker syntax to build dynamic content in the email templates. Examples of dynamic data are place holders, which are similar to variables that are part of your email template. You can also use conditional statements and list constructs to build your dynamic text.

Adding a Placeholder

Placeholders are variables that are part of your email templates. A placeholder is enclosed in curly brackets and preceded by the $ symbol. For example:

${name}

Within the curly brackets, you can enclose the placeholder name in parentheses followed by an ! symbol. This ensures that a null pointer exception is not thrown if the value for the placeholder variable is not found.

${(name)!}

The JSON response of the Sentinel EMS REST APIs is stored in the data object. With the knowledge of Sentinel EMS Rest API JSON response structures, the data object can be referenced to create place holders in the email template. For example:

${(data.entitlement.eid)!}

In the example above the placeholder will display the value of the entitlement ID in an entitlement.

All Sentinel EMS configurationrelated information that is not available as JSON response of the Sentinel EMS REST APIs in the data object, is available in the config object. The config object can be referenced to create place holders in the email template. For example:

${(config.supportEmailId)!}

In the example above the placeholder will display the technical support email from the Administration Console.

Adding Conditional Constructs

The if else conditional constructs can be used to specify conditions for Sentinel EMS. Following is the syntax, that is used to specify the if conditions:

<#if condition>
...
<#else>
...
</#if>

You can also use the elseif construct with the if condition. The syntax for using elseif within the if condition is:

<#if condition>
...
<#elseif>
...
<#elseif>
...
</#if>

The elseif and the else constructs are optional.

In the following example of conditions in Sentinel EMS email templates, the if condition is used to display the text "No Expiration Date" if the entitlement end date is set as "Never Expires". The else construct displays the entitlement expiration date if the condition specified is false.

<#if (data.entitlement.expiry.neverExpires)!false>
  No Expiration Date 
<#else>
 ${(data.entitlement.expiry.endDate)!}
  </#if>

Working with Lists

You can also list a sequence in email templates. The following syntax is used for listing a sequence:

<#list Sequence as Item>
    Part repeated for each Item
</#list>

The terms used in the syntax above are explained below:

>Sequence: Sequence or collection of the items that you want to iterate through

>Item: Name of the loop variable (not an expression)

In the following example data.entitlement.productKeys.productKey is the sequence, where the list condition is used to display all product names and versions in an entitlement.

<#list (data.entitlement.productKeys.productKey)! as productKey>
${(productKey.item.itemSuite.suite.nameVersion.name)!}
${(productKey.item.itemSuite.suite.nameVersion.version)!}
</#list>