2 Configuration

After the installation of the 'Email Order System Pro' there is a new folder 'EmailOrderSystem' in the folder 'Standard' of your web application. This folder holds the web pages that are displayed when the user accesses the 'Email Order System Pro':

After changing the context menu of the WPP Collection Basket as described in the chapter Installation (by replacing the file 'CollBasketContextMenu.jsp'), you can call the email order form by selecting the menu item 'Order by Email'.

This is the standard email order form that is shipped with the product:

If you want to change the order form, open the file '...myTomcat/webapps/EmailOrderSystemPro/Standard/EmailOrderSystem/EmailOrderForm.jsp' with a text or HTML editor.

Please note that one parameter of the order sets the subject of the email. The hidden parameter 'Subject' sets the subject of the email in the file 'EmailOrderForm.jsp' in line 35:

The extended email order form comes with fields to specify the number of ordered files and their format. It also contains a price field and a remark field to show the functionality of the TAGs 'getPrice' and 'getFieldValue'. The 'Email Order System Pro' reads the information from the Cumulus catalog record fields 'Price' and 'Remark'. If these fields are not available in your catalog, the fields in the File Selection section of the order form are left empty.

You can define mandatory fields in the email form very easily. Mandatory fields start with '_', so just insert this character at the beginning of the field name. The 'Email Order System Pro' will check all mandatory fields before the email is generated.

In the example above the field 'Name' is defined as mandatory. The following page is displayed if the user does not fill the field:

Please note that the leading '_' is not diplayed in the field name in this error page.

Remark: if you change a field name in the order form ('EmailOrderForm.jsp'), you also have to change the name of the field in the email template 'EmailTemplate.txt'.

2.2 Email body configuration

The body of the order email can be configured by using an Email Template file. The software comes with an example Email Template file called 'EmailTemplate.txt'. This is the contents of the example file:

You can put this file whereever you want onto your harddisk. You have to specify the location inside the configuration file of your web application 'web.xml' in the parameter 'EmailConfigurationFilePath'. The 'Email Order System Pro' reads the Template file and replaces the field names in brackets ([...]) against their values.

Example: [_Name] inside the Template file is replaced against the value of the mandatory field 'Name'.

An empty string is inserted if the specified field does not exist inside the order form.

The 'Email Order System Pro' also implements two placeholders to insert the date and time into the email.The placeholder for the English date format is [$DATETIME$], the placeholder for the German version is [$DATETIME_D$].

The Selection Area at the end of the Email Template file is used for the second email form (EmailOrderFormSelection.jsp). A lot of parameters are transmitted in this order form. The number of parameters depends on the number of files in the Collection Basket. The Email Template file uses the *-Notation to specify these form parameters. E.g. [a*] stands for all the Asset-Names in the email order form ('a0' to 'an').

The Email Template file seen in the example above creates an email like this:

The 'Email Order System Pro' consists of a lot of web pages (in HTML and JSP format) and a TAG library that enhances the functionality of the Cumulus Web Publisher Pro. The Tag library consists of the following TAGs:

TAG	Attribute	Description
getCollBasketList		Returns the names of the files in the WPP Collection Basket. The TAG is used for displaying the asset names in the order form and for creating a hidden parameter for the generated email.
	fieldNames	List of Cumulus record field names sperated by comma. The TAG gets the field values from the records in the WPP Collection Basket and returns them as a String.
	showFieldNames	If 'true', the field name is displayed in front of every field value, seperated by ':'.
	fieldDelimiter	The field values are seperated by this delimiter String.
	rowDelimiter	The lines are seperated by this delimiter String. If used for display in the page, use '<br>' as the delimiter, if used for providing the list as a parameter for the Email Order System, use '\n'.
	debug	If 'true', debug information is displayed in the page.
countCollBasketRecords		Returns the number of records in the WPP Collection Basket
getCatalogNames		Returns the name(s) of the open catalog(s) in the WPP Collection Basket. If there is more than one catalog open, the catalog names in the list are delimited by comma.
ifMandatoryFieldsOK		The body of this TAG is only used if all mandatory fields (field name start with '_') have been filled by the user.
ifNotMandatoryFieldsOK		The body of this TAG is only used if one of the mandatory fields (field name start with '_') has not been filled by the user.
getUserName		Returns the login name of the user.
	guestName	Sets the name that is returned when the user is logged in as 'Guest' (no username and password)
sendEmail		Sends the email using the setup STMP server to the given address or creates setup error messages.
	listName	Name of the order form field that holds the list of files for the email.
	encoding	Name of the encoding used for the email text. Default is 'UTF-8'. The encoding attribute can be changed in the file 'SendEmail.jsp'.
	contentType	The attribute specifies the content type of the order email. Default is '' (empty), the email will be sent as a text email. If the email should be sent in HTML format, the atrribute should be 'text/html'.
	debug	If 'true', debug information is displayed in the page.
forEveryItemInBasket		The body of this TAG is evaluated n times for every record in the Collection Basket.
getNumberBox		A textbox will be created to specify the number of ordered files for every record in the Collection Basket. The names of the created form fields start with 'n' and are numbered from 0 to n (n = number of records) n0...nn.
getAssetName		Returns the names of the assets for every record in the Collection Basket. The names of the created form fields start with 'a' and are numbered from 0 to n (n = number of records) a0...an.
getSelectionName		Returns the names of the selection form fields for every record in the Collection Basket. The names of the created form fields start with 's' and are numbered from 0 to n (n = number of records) s0...sn.
getFieldValue		Returns the value of the record field given in the attribute 'fieldName' for every record in the Collection Basket.
	fieldName	The name of the record field which value should be returned.
getPrice		Returns the value of the record field given in the attribute 'fieldName' for every record in the Collection Basket formatted as a price tag. The values of the field types String, Integer or Double are converted to a currency format with a given comma notation. Please note that the number is truncated(!) after two digits behind the commma. Example: Attribute currency: 'US$' Attribute delimiter: '.' Attribute delimiter1: ',' Integer: 1234 is displayed as US$ 1,234.- Double: 1234,5678 is displayed as US$ 1,234.56 A String value will be displayed as given in the field with the currency character in front The names of the created form fields start with 'p' and are numbered from 0 to n (n = number of records) p0...pn.
	fieldName	The name of the record field which value should be returned.
	currency	The name of the currency in HTML format which is added in front of the number (e.g. '&euro;' for Euro or '&#36;' for $).
	delimiter	"," or "." - delimiter between the Euro/Cents or Dollars/Cents
	delimiter1	"," or "." - delimiter at every third position of the number to improve readability