Email and Templates setup

Email templates

Email templates allow you to customize the e-mails received by your users from the licensing system so that they can be branded with your logos and communicate as you see fit. These templates are easily customized through the Nitro-LM Admin application.

Notifications and Templates

Not all Notifications that come from Nitro-LM require a template. Some internal events are just sent as is.  In general if a user is going to see it then it needs a template; if only admins will see it then it does not.


Email templates are single HTML files. They can contain internal style sheets, but images and external (.css) style sheets must be linked from some publicly-accessible server for them to show up. An Email template could be a simple text file too, if no formatting is desired. The important thing is that the replaceable variables be readable in clear text.

An email template will contain one or more variables, delimited by dollar-signs on either side.  These will be replaced with appropriate values before the emails are sent. Your email does not have to include the variables, but they should be useful.

Note: when an email contains links, it may sometimes be blocked by spam filters.

Below is a sample HTML document that contains examples of some of the tags that the Nitro-LM server performs in-line substitutions on the send of the mail. In this case: '$companyName$' and '$confirmLink$'.

HTML Reference Example - Pool Activation
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1" />
<title>Pool activation</title>
<style type="text/css">
<!--
.style1 {
	font-family: Arial, Helvetica, sans-serif;
	font-size: 30px;
}
.style2 {font-family: Arial, Helvetica, sans-serif}
.style4 {font-size: 10px}
-->
</style>
</head>

<body>
<table width="100%" border="0" align="center" cellpadding="0" cellspacing="0">
  <tr>
    <td width="1"><img src="<YOUR_IMAGE_URL>" width="175" height="116" /></td>
    <td width="76%" valign="bottom"><span class="style1">License Pool Activation</span></td>
  </tr>
</table>
<hr align="center" width="95%" size="1" />
<p class="style2">You are receiving this e-mail because a new license pool has been created for your company on our server.</p>
<p class="style2">A new pool of licenses has been created for $companyName$.</p>
<p class="style2">To activate this pool, click on the following link: $confirmLink$ </p>
<p class="style2"><span class="style4">If you have any problems,
or believe that you have received this notification in error,
please contact us at <a href="mailto:support@nitromation.com?Subject=Pool Activation">support@nitromation.com</a></span> </p>
<p class="style2">&nbsp;</p>
<p class="style2">&nbsp; </p>
</body>
</html>
Using CSS

Since the content is coming from Nitro-LM, it is strongly encouraged to embed any CSS in your HTML file.
You can reference CSS files but these will have to be hosted at your own web site or externally at a stable location.

The menu option is called Email Templates and launches a new screen to allow you to customize and edit templates for your company.

From this screen, you can specify a custom SMTP server that can be used for sending the e-mails. This allows your own server to do bounced e-mail handling. If a user mistypes an e-mail address, you can be notified by your SMTP server. All e-mails will be coming from your own company's e-mail servers to complete the branding experience. You can also edit the HTML email templates and drag/drop variables so they can be inserted into the outgoing message by the server.

The Preview tab allows you to see what the e-mails you send out will look like.

Templates

A new demo has been requested

Type: Notification

Sent when a user has requested a new demo for a product which has "Approve All New Demos" checked.  Sent to people at the Licensee who have the "D" notification type.

A new pool has been activated

Type: Notification

Sent to the responsible parties for a customer after a new license pool has been activated (confirmed).

Bailout notification

Type: Notification

Sent when the client application has used the sendSurvey() API call, usually when the user has quit the application without registering.  Sent to people at the Licensee who have the "B" notification type.

Demo renewal approved notification

Type: Notification

Sent when an admin has approved a demo renewal request.  Sent to people at the Licensee who have the "DN" notification type.

Demo renewal denied notification

Type: Notification

Sent when an admin has denied a demo renewal request.  Sent to people at the Licensee who have the "DN" notification type.

Demo renewal is approved

Type: User

Sent to users who have requested a demo extension, informing them their request has been approved.

Demo renewal is denied

Type: User

Sent to users who have requested a demo extension, informing them their request has been denied.

License is now available

Type: User

When a user's license request has been placed into a queue, this email is sent to notify them that a slot is now available and has been temporarily reserved for them.

License request in queue

Type: User

When a user's license request has been placed into a queue, this email informs them (in addition to any on-screen message)

Licenses have been moved into a pool

Type: Notification

When licenses have been moved from a parent customer to a child customer, this email is sent to the responsible parties of the child customer to notify them that licenses have been added.

Licenses have been moved out of a pool

Type: Notification

When licenses have been moved from a child customer to a parent customer, this email is sent to the responsible parties of the child customer to notify them that licenses have been removed.

Maximum demos have been used

Type: Notification

Sent to the responsible parties for a Licensee when a user has requested a demo but no more demos are allowed for the Licensee.

New demo approved notification

Type: Notification

Sent when an admin has approved a new demo request for a product which has "Approve All New Demos" checked.  Sent to people at the Licensee who have the "DN" notification type.

New demo denied notification

Type: Notification

Sent when an admin has denied a new demo request for a product which has "Approve All New Demos" checked.  Sent to people at the Licensee who have the "DN" notification type.

New demo is approved

Type: User

Sent to users who have requested a new demo for a product which has "Approve All New Demos" checked, informing them their request has been approved.

New demo is denied

Type: User

Sent to users who have requested a new demo for a product which has "Approve All New Demos" checked, informing them their request has been denied.

NitroAdmin access granted

Type: User

Sent to users who have been granted some level of access to the NitroAdmin application.

No licenses are available at this customer

Type: Notification

Sent when a user has requested a license, but no more licenses for the product are available at the customer.  Sent to people at the Licensee and Customer who have the "NL" notification type.

No licenses were purchased by this customer

Type: Notification

Sent when a user has requested a license, but no licenses for the product where assigned to the customer.  Sent to people at the Licensee and Customer who have the "NL" notification type.

Product Extension approved

Type: User

Sent to users who have requested a product extension on their pool, informing them their request has been approved.

Product Extension approved notification

Type: Notification

Sent when an admin has approved a product extension on a pool.  Sent to people at the Licensee and Customer who have the "PE" notification type.

Product Extension denied

Type: User

Sent to users who have requested a product extension on their pool, informing them their request has been denied.

Product Extension denied notification

Type: Notification

Sent when an admin has denied a product extension on a pool.  Sent to people at the Licensee and Customer who have the "PE" notification type.

Registration Confirmation (code)

Type: User

The second of two emails which may be sent to a user to confirm their registration.  This email will contain only a confirmation code, which the user will have to paste into an application screen.  If the Licensee's email confirm type is set to "Confirm Link Only" then this email will not be sent.

Registration Confirmation (link)

Type: User

The first of two emails which may be sent to a user to confirm their registration.  This email will contain a confirmation link for the user to click on.  If the Licensee's email confirm type is set to "Confirm Code Only" then this email will not be sent.

Request for a demo renewal

Type: Notification

Sent when a user has requested a demo renewal.  Sent to people at the Licensee who have the "DR" notification type.

Request for a new demo

Type: Notification

Sent when a user has requested a new demo for a product which has "Approve All New Demos" checked.  Sent to people at the Licensee who have the "DR" notification type.

Request for a pool product extension

Type: Notification

Sent when a user has requested a product extension on a pool.  Sent to people at the Licensee who have the "PE" notification type.

Reset password confirmation

Type: User

Sent to a user after they click on a reset-password link (such as "I forgot my password").

Support request

Type: Notification

Sent when the client application has used the emailSupport() API call to send a request for Sales, Technical or Enhancement support.  Sent to people at the Licensee who have the "SS", "ST", or "SE" notification type as appropriate.

User registration notification

Type: Notification

Sent when a user has registered and confirmed their registration.  Sent to people at the Licensee who have the "R" notification type.

Variable logging error

Type: Notification

Sent when variable-logging batch uploads have encountered errors on the server.  Sent to people at the Licensee and Customer who have the "BE" notification type.

Web page

Type: User

This is a special kind of template: rather than being used for email, this template is used for web pages presented to users, so that they can be branded.  The template acts as a wrapper around any of the standard NitroLM internal web pages; these pages include

  • The login page that lets you change or reset your password
  • The change-password page
  • The reset-password page
  • The message pages that come up after you perform an action, such as confirming a user registration, denying a demo renewal, or changing your password.

The Web Page ID value is what controls the template wrapper for the page.  For most pages you do not have to worry about the ID, since it will be passed from another page either in browser memory or as an argument in the URL (confirmation links sent in email will contain the Web Page ID as part of the URL).

Comments