Skip to main content

Configuring Email Templates

Email templates are text files with pre-defined contents. These templates are used by default when emails need to be send to end customers after creating a new license or a license update. The product information as well as the license information or other required information are inserted into a standard text by using placeholders. This simplifies production of licenses enormously because all license information are provided to the end customer in a default manner without need writing down the information by hand all time.

Emails to end customers can be send after creating new serial number licenses or new dongle licenses. For this type of email one template is available.

Another email might be sent after a serial number license update or a dongle license update has been created. A different template is available for this type.

Default email templates are installed together with the Licensing Tool. They are stored in the "MailTemplates" sub-folder of the installation folder of the Licensing Tool (e.g: "C:\Program Files\LabCognition\Licensing Tool 1.0\MailTemplates")

New License Email Template

A typical template for a new license email being sent to an end customer looks like this:

Dear Ladies and Gentlemen,

Thank you for your order of %PRODUCT% with PO#: %ORDERID%!

The following items have been ordered:

Product: %BASEPRODUCT%

Additional Add-On Modules:

%MODULES%

The following license information has been created based the ordered items:

Serialnumber: %SERIALNO%

Placeholders are bracketed by % characters (see below).

The contents need to be saved in a text file in the MailTemplates folder. The file name must be LicenseCreationEmail.txt

License Update Email Template

A typical template for a license update email being sent to an end customer looks like this:

Dear Ladies and Gentlemen,

Thank you for your %BASEPRODUCT% product update with PO# %ORDERID%

Your current license includes the following modules:

%LICENSEDMODULES%

The new license contains the following modules:

%LICENSEDMODULES%

%MODULES%

The following license information has been created based the ordered items:

Serialnumber: %SERIALNO%

Placeholders are bracketed by % characters (see below).

The contents need to be saved in a text file in the MailTemplates folder. The file name must be LicenseUpdateEmail.txt

Placeholders

Placeholders can be used in the email templates and also in the folder/file names used in the Options dialog. Placeholders are replaced by actual values during runtime of the Licensing Tool. Placeholders require a specific syntax to be identified by the Licensing Tool. Hence the placeholder name is bracketed in % characters.

Example: %PLACEHOLDER%

In order to find them easily in the text the name is written upper case.

Below you find a complete list of all available placeholders and their meanings:

Placeholder

Description

%PRODUCT%

Name of the original product/software delivered to the customer.

%BASEPRODUCT%

Fully qualified product name as shown in the "Base Software" list box in the Licensing Tool.

%ORDERID%

Value inserted by the Licensing Tool user into the PO# field during license creation.

%MODULES%

List of all selected (checked) fully qualified add-on module names as shown in the "Add-On Modules" list box of the Licensing Tool. This means the list of all add-on modules added to the new license or license update.

%LICENSEDMODULES%

This placeholder is valid for license updates. It holds a list of all add-on modules licensed in the initial license. The list contains fully qualified names as shown in the Licensing Tool.

%SERIALNO%

Serial number of the license

%DONGLEID%

Dongle number of the dongle.

%VERISON%

version number of the software delivered to the customer. This is the software version number obtained from the *.MSI file.

%LICENSETYPE%

This placeholder is replaced by fixed texts depending on the license type. The following texts are returned:

  • Dongle Creation

  • Serialnumber Creation

  • Dongle Update

  • Serialnumber Update

%DATE%

Actual date

%TIME%

Actual time

%USER%

Licensing Tool user name taken from the login information

%OEM%

Licensing Tool profile name. Typically this is the legal name of the Licensing Tool user's company  (for internal use only!)