Customizing E-mail Templates

When you perform specific actions in Sentinel LDK-EMS, such as creating an Entitlement, Sentinel LDK-EMS sends an e-mail to the customer and channel partner.

Sentinel LDK-EMS templates use standard HTML structure, as well as variables that are placeholders for dynamic data, such as an email address or customer ID. Each variable is surrounded by # (hash tags). E-mail templates are stored as .tpl files in: %EMS_HOME%\EMSServer\webapps\ems\WEB-INF\classes

You can modify these e-mail templates to customize the messages, as needed. For example, you may want to add a special greeting or include more information. The following example shows how a download link for Electronic Software Delivery (ESD) might be added to the EntitlementCertificateEmail.tpl using standard HTML syntax.

  ...
  ...
  <tr><td colspan="4">You can download the latest software version from: <a href="https://www.mycompany.com">https://www.mycompany.com/</a></td></tr>
  <tr><td colspan="4">For further assistance, contact us using the following details: </td></tr>
  <tr><td colspan="4">Contact No. - #supportContactNo# </td></tr>
  <tr><td colspan="4">Email - #supportEmailId#</td></tr>
  <tr><td colspan="4" height="5px"><br/><br/></td></tr>
  <tr><td colspan="4">Sincerely,<br/>#supportTeamName#</td></tr>
</table>

To view a template's syntax:

In a text editor, open the corresponding .tpl file.

To customize an e-mail template:

In a text editor, edit the corresponding .tpl file. For details on the available e-mail templates and variables, see Sentinel LDK-EMS Templates and Template Variables.

CAUTION! Do not edit the variables.

To preview an e-mail template:

Do one of the following:

>Preview in a browser.

a.Make a copy of the .tpl file you want to preview.

b.Change the extension of the copied file to .htm.

c.Open the .htm file in a browser.

CAUTION! Do not delete or rename any pre-existing files.

>Generate a sample email. In the DEMOMA batch code, perform an action that generates the relevant e-mail, making sure to include your own e-mail address instead of your Customer or Channel Partner's e-mail. For example, you can create an Entitlement to send yourself an Entitlement-related e-mail.

Sentinel LDK-EMS Templates

The following table provides a list of available templates.

Base template	Variables
ContactCertificateEmail21.tpl E-mail template for contact certificate when customers registers. Includes: ContactCertifcate21.tpl. Meant for: Customers	#contactName# #emailURL# #supportContactNo# #supportEmailId# #supportTeamName# #MasterFooter#
EntitlementCertificateEmail.tpl E-mail template for notifying success of LDK Entitlement creation. Includes: This template includes one of the following: >EntitlementCertificate21.tpl >EntitlementCertificateAttachment21.tpl Meant for: Publisher / Channel Partner	#contactName# #emailURL# #supportContactNo# #supportEmailId# #supportTeamName# #MasterFooter#
LicenseCertificateEmail.tpl (E-mail template for license certificate.) Includes: LicenseCertificate21.tpl. Meant for: Customers	#contactName# #supportContactNo# #supportEmailId# #supportTeamName# #MasterFooter#
Contained templates
ContactCertificate21.tpl Contact certificate for user registration.	#contactEmail# #customerName# #ProductKey#
EntitlementCertificate21.tpl	#eid# #startDate# #endDate# #customerName# #contactEmail# #channelPartnerNameEmail# #productKeyLabel# #productKeyCountORproductKey# #QuantityPerProductKey# #itemRowStart# #itemDescription# #itemLockType# #itemRowEnd#
EntitlementCertificateAttachment21.tpl	#eid# #channelPartnerName# #partnerContactEmail# #customerName# #contactEmail# #startDate# #endDate# #productKeyLabel# #productKeyCountORproductKey# #QuantityPerProductKey# #itemRowStart# #itemDescription# #itemLockType# #itemRowEnd# #pkRowStart# #pkItemSNo# #itemProductKey# #pkRowEnd#
LicenseCertificate21.tpl	#contactEmail# #customerName# #pkid# #quantity# #remainingQuantity# #itemRowStart# #itemDescription# #itemLockType# #itemRowEnd#

Base template

Variables

ContactCertificateEmail21.tpl

E-mail template for contact certificate when customers registers.

Includes:

ContactCertifcate21.tpl.

Meant for:

Customers

#contactName#

#emailURL#

#supportContactNo#

#supportEmailId#

#supportTeamName#

#MasterFooter#

EntitlementCertificateEmail.tpl

E-mail template for notifying success of LDK Entitlement creation.

Includes:

This template includes one of the following:

>EntitlementCertificate21.tpl

>EntitlementCertificateAttachment21.tpl

Meant for:

Publisher / Channel Partner

#contactName#

#emailURL#

#supportContactNo#

#supportEmailId#

#supportTeamName#

#MasterFooter#

LicenseCertificateEmail.tpl

(E-mail template for license certificate.)

Includes:

LicenseCertificate21.tpl.

Meant for:

Customers

#contactName#

#supportContactNo#

#supportEmailId#

#supportTeamName#

#MasterFooter#

Contained templates

ContactCertificate21.tpl

Contact certificate for user registration.

#contactEmail#

#customerName#

#ProductKey#

EntitlementCertificate21.tpl

#eid#

#startDate#

#endDate#

#customerName#

#contactEmail#

#channelPartnerNameEmail#

#productKeyLabel#

#productKeyCountORproductKey#

#QuantityPerProductKey#

#itemRowStart#

#itemDescription#

#itemLockType#

#itemRowEnd#

EntitlementCertificateAttachment21.tpl

#eid#

#channelPartnerName#

#partnerContactEmail#

#customerName#

#contactEmail#

#startDate#

#endDate#

#productKeyLabel#

#productKeyCountORproductKey#

#QuantityPerProductKey#

#itemRowStart#

#itemDescription#

#itemLockType#

#itemRowEnd#

#pkRowStart#

#pkItemSNo#

#itemProductKey#

#pkRowEnd#

LicenseCertificate21.tpl

#contactEmail#

#customerName#

#pkid#

#quantity#

#remainingQuantity#

#itemRowStart#

#itemDescription#

#itemLockType#

#itemRowEnd#

Template Variables

Variables	Description
#supportTeamName#	A name for your customer support team.
#supportEmailId#	Your customer support E-mail ID.
#supportContactNo#	Your customer support phone numbers.
#startDate#	Entitlement start date.
#remainingQuantity#	The total number of activations still available in the Product key.
#QuantityPerProductKey#	Number of activations for the Product key.
#quantity#	The number of times a Product can be activated.
#productKeyLabel#	Displays the label as Product Key or Product Keys depending on the number of keys.
#productKeyCountORproductKey#	>Single Product key: Displays the Product key string. >Multiple Product keys: Displays the total number of keys.
#ProductKey#	The Product key string.
#pkRowStart#	The Product keys list for an entitlement starts from here.
#pkRowEnd#	The Product keys list for an entitlement ends here.
#pkItemSNo#	Serial number of the Product key in the list.
#pkid#	The product key.
#partnerContactEmail#	E-mail ID of the Channel Partner contact.
#MasterFooter#	Copyright info that is included at the end of the mail.
#itemRowStart#	The list for Products in an entitlement starts from here.
#itemRowEnd#	The list for Products in an entitlement ends here.
#itemProductKey#	Displays the Product keys in the a list.
#itemLockType#	Locking type of the Product.
#itemDescription#	Product/Suite name.
#endDate#	Entitlement end date.
#emailURL#	URL of the Sentinel LDK-EMS server used by the order taker when creating an entitlement. TIP You can modify the URL of the Sentinel LDK-EMS Customer Portal used in emails by setting a value in the Administration > Administration Console > General Configuration > Email Link to Sentinel LDK-EMS Customer Portal box.
#eid#	Entitlement ID.
#customerName#	Name of the Customer.
#contactName#	Name of the Contact.
#contactEmail#	E-mail ID of the Contact.
#channelPartnerNameEmail#	E-mail ID of the Channel Partner.
#channelPartnerName#	Name of the Channel Partner.
#RefID1#	Reference ID 1. An identifier from another system, such as CRM/ERP.
#RefID2#	Reference ID 2. An identifier from another system, such as CRM/ERP.
#customerRefIdValue#	Customer reference ID.
#productVersionValue#	The Product version.