FlexNet Operations Cloud Notification Email Template Structure and Modification

Summary

FlexNet Operations Cloud email templates used in notification functions such as customer account creation, password reset and product entitlement are all stored in a Java properties file. This articles describes the structure of the template and how to modify a template.

Synopsis

FlexNet Operations Cloud email templates used in notification functions such as customer account creation, password reset and product entitlement are all stored in a Java properties file. This articles describes the structure of the template and how to modify a template.

Discussion

The Email Template File

Templates are stored in a single Java properties file called email.properties located in the com.flexnet.delivery.i18n package in delivery-ejb.jar. delivery-ejb.jar is embedded in the delivery-admin.ear file located in the following directory:

<Install Dir>\JBoss\server\publisher\deploy

File Structure

The properties file contains specific key\ value pairs that that correspond to sections in the emails. A number of the values have parameter place holders that allow the insertion of relevant information such as customer name, company log etc. The parameters are denoted by {n}. Where n is a 0 based parameter number. The following is a snippet of a key\value pair used in the FLEXNet Delivery email template. Note: the value text is shortened for brevity.

assignProducts.body=<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"\

"http://www.w3.org/TR/html4/loose.dtd">\

<html>\

{0}\

The following table lists all the key words in the properties file and their corresponding sections in the emails sent from FLEXnet Delivery.

Email Type	Key	Key Description	Value Parameter	Parameter Description
Product Entitlement	assignProducts.subject	Email subject text	none
	assignProducts.head	Email header image and CSS stylesheet	none
	assignProducts.body	Email message body	0	The header text value assigned to the ?assignProducts.head? keyword above.
			1	Customer?s first name
			2	Assigned products (product and version string) surrounded by the begin and end HTML list item followed by a HTML break tag. i.e. <li>JEditor 1.0</li> <br <li>JEditor 2.0</li> <br <li>JEditor 3.0</li> <br
			3	Customer Interface URL base configured in the settings page.
Customer account creation	newCustomer.welcome.subject	Email subject text	none
	newCustomer.welcome.head	Email header image and CSS stylesheet	none
	newCustomer.welcome.body	Email message body	0	The header text value assigned to the ?newCustomer.welcome.head? keyword above.
			1	Customer?s first name
			2	Customer?s FLEXnet Delivery username (email address)
			3	Customer?s FLEXnet Delivery password
			4	Customer Interface URL base configured in the settings page.
Customer password reset	customer.passwordReset.subject	Email subject text	none
	customer.passwordReset.head	Email header image and CSS stylesheet	none
	customer.passwordReset.body	Email message body	0	The header text value assigned to the ?customer.passwordReset.head? keyword above.
			1	Customer?s first name
			2	Customer?s FLEXnet Delivery username (email address)
			3	Customer?s FLEXnet Delivery password
			4	Customer Interface URL base configured in the settings page.

How to Modify the Template

Task

To modify the email.properties file:

Extract the email.properties file from delivery-ejb.jar and modify the text. Once you are done modifying the file save it back into the delivery-ejb.jar.

Note

One needs to follow the following set of rules when editing the file.

1. The key words cannot be changed

2. Value parameters should not be removed. If you do not want to have a parameter value appear in the email, simply comment it out using HTML comment tags ().The order of the parameters can be changed.

Also value parameters can be reordered. i.e. parameter {1} can be placed before {0}.

FlexNet Operations Cloud Notification Email Template Structure and Modification