©2003-2010, Heymann Consulting
Email Order System Pro (EOSP) - Version 8.0.2
 
Documentation
 
Documentation Version: 8.0.2
last modified: 16-05-2010  
 

Contents

 

0 Introduction

   0.1 Tryout Version
   0.2 Email Order System Pro Version 8.0 Enhancements - New Features
   0.3 Special Thanks

1 Installation

   1.1 Simple Installation
   1.2 Installation of the 'Collect Files' EJaP
   1.3 How to use EOSP with the Modula4 Web Module

2 Configuration

   2.1 Basic Configuration (Admin Pages)
   2.2 More Configuration Options

      2.2.1 Definition of mandatory fields
      2.2.2 Email body configuration
      2.2.3 The EOSP Tag Library
      2.2.4 Send email order in HTML

3 Finding the ordered files in the Cumulus Catalogs (Collect Files EJaP)

4 Miscellaneous

   4.1 bcc: the email order
   4.2 Show catalog name in email order form for Multi-Catalog Collections
   4.3 Use Asset Actions to convert files
   4.4 Multi-Language Support
   4.5 Auto-Fill order form with user information from Cumulus $Users Catalog (Server Console)
   4.6 Disable Save Permissions on a Demo Server

5 Feedback & Support

6 Version History

 

0 Introduction

 

 
 
The Email Order System Pro Example Web Application
 

The Email Order System Pro is an extension to the Canto Cumulus Web Publisher Pro (WPP) or Internet Client Pro (ICP) Option. The new version supports WPP/ICP (3.0 Design' web applications) for Cumulus 7.5 and 8.0 or higher.

With the help of this extension, the user of the WPP/ICP can order files from his service provider by email. An order form will be displayed which can be configured by the administrator of the website. The order form information will be sent to a given email address after mandatory fields evaluation. For the person who processes the order, the 'Email Order System Pro' comes with functions (implemented for the Cumulus Client as an EJaP) for Mac OS and Windows which helps to find the ordered files in the Cumulus catalog. The EJaP (Embedded Java Plugin) 'CollectFiles' also performs the specified Asset Actions(!) to convert the files. It will also inform about missing files in the catalog.

The 'Email Order System Pro' comes with two different order forms. The first form is used to send a list of the ordered file names (+ additional information) in the order email, the second form enables the user to also specify the number of ordered files, the format, the price or additional information. The second order form is used by print service providers.

The new version of Email Order System Pro supports multiple catalogs (Multi-Catalog Collections) and also supports multiple languages. The product supports German and English out of the box, more languages can be added in localisation files easily! The order emails can be sent in text or html format.

Do you need additional functionality in the product? We develop additional functionality based on your needs. Send an email with your feature requests by clicking here.

 
 
The first predefined form (configurable) to order the files by email
 


0.1 Tryout Version

The tryout version of the 'Email Order System Pro' is a full version of the product, so you can test all the functionality available.

 
 
The tryout version info displayed in the email order form
 

The limitation: the order form will show a demo info and a link to our website. Also the order email shows the demo information. In the demo version the email order will also be sent to an internal Heymann Consulting email adress as a bcc email. There are no other limitations in the tryout version. The demo version is for testing purposes only and you are not allowed to use it in a working environment! To order the full version of the product, send an email to Heymann Consulting.

The full version comes with a serial number that unlocks your demo installation, so you do not have reinstall anything.


0.2 Email Order System Pro Version 8.0 Enhancements - New Features

The Email Order System Pro Version 8 comes with a lot of enhancements and brand new features to make life of the Cumulus Administrator easier and the solution even more powerful. This is a list of some of the main new features of Version 8:

1. Easy drag&drop install

The new Email Order System Pro 8 comes with a simple easy drag&drop install mechanism. This new version has been designed for Cumulus 8, but also works with all Cumulus 7.5/7.6 releases. You can install the solution just by copying the contents of an installation folder into your current Cumulus web application.

You can read the details on how to install the software in this documentation in chapter 1.1 Simple Installation.

2. New Admin Pages

The product comes with new Admin Pages inside the web application to make the configuration more comfortable. These Admin Pages allow configuration, registration of the software, checking for updates and accessing the Email Order System Pro documentation.

Learn more about how to use the admin configuration functions in chapter 2 Configuration.

3. System-wide, web application based or catalog based configuration

The new configuration mechanism allows to specify configuration parameters for the web application and all the users in all the Cumulus catalogs or you can specify different setups on a web application base or depending on the catalog that has been opened by the user. With this feature it is possible to use different languages in different web applications easily and for example you can have different Email Order Recipients for different Cumulus catalogs. Here is an example configuration:

# --- Language used for messages: de_DE = German, en_US = English ---

EmailOrderSystemProLanguage=en_US
EmailOrderSystemProLanguage.catalog.Sample\ Catalog=en_US
EmailOrderSystemProLanguage.catalog.Beispielkatalog=de_DE
EmailOrderSystemProLanguage.webapp.Cumulus_Z=en_US
EmailOrderSystemProLanguage.webapp.Cumulus_D=de_DE

The example configuration above defines the English language as the standard for all order forms on this web server. But if the user opens the German web application 'Cumulus_D', the EOSP language is set to German. You can also define a language based on the opened catalog (see example: German 'Beispielkatalog').

The order of using these configuration parameters is: web application setting, catalog setting and standard setting.

4. Show Thumbnails in the Order form

The new TAG 'getThumbnail' allows to show the thumbnails from the Cumulus catalog in the order form. You can specify the size of the Thumbnail in the TAG attribute 'size'.

 
getThumbnail
 
You can show the Thumbnail in the Order Form
 

5. Improved EJaP to collect the files

A new version of the Collect Files EJaP for the Cumulus Client comes with the product.

6. New TAGs and attributes

New TAGs have been implemented to make the solution even more flexible and powerful. The administrator has even more options to configure the behaviour of the web application.

You can read a description of every TAG in this documentation in chapter 2.2.3 The EOSP Tag Library.

7. HTML Template improvements

The HTML Template files have been optimized. They are using stylesheets for the better display of information.


0.3 Special Thanks

A special thanks to all who have contributed to the development and improvement of this product. Thank you very much to our sales partners and all our current Email Order System Pro customer who helped us to develop this useful product. We are looking forward to even more feedback from you to make this product even better...

 

 

1 Installation

 

The System Requirements of the Email Order System Pro product follow the system requirements of your Cumulus Web Publisher Pro or Internet Client Pro installation (see Canto documentation for details).

Before you install the software, please read the license agreement carefully. You can find the license file 'License.txt' inside the product folder. By installing the software, you accept this license agreement.


1.1 Simple Installation

You will find all the files that are necessary to integrate into your web application inside the 'Installation' folder of the 'Email Order System Pro' product folder.

IMPORTANT: Please keep in mind that the EOSP is designed to work with the Cumulus web application in 3.0 Design (Cumulus Classic web application). You can not use this technology with Cumulus Client-like web application using AJAX technology.

After the standard installation of Cumulus WPP/ICP you will find the Cumulus web application inside the folder 'Cumulus_Z' (English version) or 'Cumulus_D' (German version) inside the folder 'webapps' of your Tomcat application folder. If you are using WPP/ICP 7.5,76 or 8.0, the web applications in 3.0 Design (as Canto calls it) can be downloaded from the Canto website. After installing the web applications you will find the folders 'Cumulus_Z' (English version) or 'Cumulus_D' (German version). The naming convention for the Internet Client Pro adds an 'E' to the name of the web application ('CumulusE', 'CumulusE_D', 'CumulusE_Z'). If you are already working with a renamed duplicate of the standard folder, make sure that you are integrating the files into the correct folder.

This is what you have to do to install EOSP8:

1. Stop your web application server Tomcat.

2. Copy the contents(!) of the folder 'Installation/Copy Into Your Web App' that you can find inside the product folder into your web application folder.

This will

- copy the file 'EmailOrderSystemPro.jar' into your web application folder 'myWebApp/WEB-INF/lib'
- copy the file 'EmailOrderSystemPro.tld' into your web application folder 'myWebApp/WEB-INF'
- add the menu items to your collection basket menu by copying the files 'CollBasketContextMenu.html' (sets the size of the menu) and 'CollBasketContextMenu.jsp' (defining the menu items) that you can find in folder 'myWebApp/Standard' into your web application folder 'myTomcat/webapps/myWebApp/Standard'. If you have already changed the Collection Basket menu in your web application, just copy the lines from the file 'CollBasketContextMenu.jsp' that add the new menu items.

3. Please make sure that your Cumulus SMTP Server setup (in the web.xml file) is correct (see Canto documentation for details).

To make the web application work with your email server configuration please specify your email server parameters in the Canto configuration file '/WEB-INF/web.xml', as usual. Here are the parameters to be specified:

- SMTP Server: mail.smtp.host
- SMTP User: mail.smtp.user
- SMTP Password: mail.smtp.password
- Sender: com.canto.cumulus.web.pub.SenderEMail

If you have already configured these attributes in another web application, you can just copy and paste the 'web.xml' file from there.

4. Restart your web application server Tomcat.

After restarting your Tomcat web application server you can access the site e.g. via 'http://myServer:8080/myWebApp/' (if your Tomcat is using TCP/IP port 8080 for communication). You will notice that the menu in the Collection Basket changed to allow Email Order and Email Order with selection.

5. Configure the Email Order System Pro attributes by opening the URL

http://myServer(:8080)/myWebApp/Standard/EmailOrderSystemPro/admin

Change the configuration to meet your needs as described in chapter 2 Configuration.

Put some files into the Collection Basket and select the Collection Basket context menu item 'Order by Email' to display the email order form.

Remark: When a user accesses the web application, the Cumulus Web Publisher Pro checks the version of the user's web browser. If the web browser is not Internet Explorer version 5 (or higher) or Netscape version 6 (or higher), the user is linked to the folder 'Compatible', which uses a display method without advanced web technologies. The 'Email Order System Pro' is not implemented in the 'Compatible' directory.


1.2 Installation of the 'Collect Files' EJaP

The 'Email Order System Pro' comes with an application called 'Collect Files' to find the ordered files in the Cumulus catalog. This application is a Cumulus EJaP (Embedded Java Plugin) based on Canto's EJaP technology.

In the product folder you will find a folder '/Installation/Collect Files EJaP'. In the folder, you will find a sub-folder 'CollectFiles'. Copy this sub-folder ('CollectFiles' and its contents) into the 'ejp' folder in the installation folder of your Cumulus Client application. Under Windows it is e.g. 'C:\Program Files\Canto\Cumulus 8 Client\ejp', under Mac OS X it is 'Macintosh HD/Applications/Cumulus 8 Client'. The 'ejp' folder of the Cumulus application can be found in the Cumulus package. You can reach this folder by clicking the mouse-button while holding down the CTRL-key on the Cumulus application. Click on 'Show Package Contents' in the context-menu. This will open a Finder window with a subfolder 'Contents'. In that folder you will find a 'MacOS' folder and there you will find the 'ejp' folder in which to copy the 'CollectFiles' folder.

Restart the Cumulus application to use the 'Collect Files' application, it will show a new menu item in your Cumulus application called 'Email Order System Pro'.

Important: if you already have an older version of the EJaP installed (filename 'CollectFiles.ejp'), please delete the old version before you restart your Cumulus Client! Only use this version if you have a Cumulus version 7.5 or higher installed!


1.3 How to use EOSP with the Modula4 Web Module

The Email Order System Pro can be used with the Cumulus Web Publisher Pro or Internet Client Pro web applications (3.0 Design), but it can also be used with the WebModule product developed by Modula4. The Modula4 Web Module simplifies usage enormously compared to WPP/ICP due to a trimmed-down design, intuitive user-guidance and significantly increased speed. Modula4 uses the newest technologies to make your websites even more interactive.

 
 
EOSP inside Modula4's WebModule
 

EOSP comes pre-installed in all new WebModule versions (version 3 and higher). You only have to switch EOSP on by setting a parameter in the WebModule web.xml configuration file (/WebModule30/WEB-INF/web.xml):

 
 
Modula4's WebModule configuration file
 

Set the parameter 'EOSPEnabled' to 'true' to use EOSP inside of the WebModule. The links that will bring up the Email Order Forms will automatically show up in the Collection Basket page:

- Order by Email
- Order by Email with Selection

Please make sure that your Cumulus SMTP Server setup (in the web.xml file) is correct (see Canto documentation for details) to allow sending emails. Configure the Email Order System Pro attributes and provide the serial number of EOSP by opening the URL

http://myServer(:8080)/myWebModule/EmailOrderSystemPro/admin.

 

2 Configuration

 

The Email Order System Pro can be easily configured by using the Admin Pages that are installed inside your web application. When saving the settings through the Admin Pages for the first time, a configuration file (filename: 'eosp8.properties') is created in the /temp/ directory of Tomcat.

After creating that file you can use the Admin Pages to change the settings or edit the configuration file 'eosp8.properties' with a text editor directly.


2.1 Basic Configuration (Admin Pages)

The Email Order System Pro comes with Admin Pages that help the Administrator to configure the settings of the EOSP functions. You can access the Admin Pages by opening this URL:

http://myServer(:8080)/myWebApp/Standard/EmailOrderSystemPro/admin

You will be redirected to the Login Page which requires the Cumulus Administrator Login to access the configuration pages. You can select the language of the configuration pages: English or German. You can add more languages, if you like.

 
adminLogin
 
The Email Order System Pro's Admin Login Page
 

The Basic Configuration Page displays information about your current web application settings (like product serialisation and Cumulus web application Mail Server Settings).

 
adminShowConfig
 
The Email Order System Pro's basic settings
 

The mail server settings are read from the web application's configuration file 'web.xml'. You can read more about how to set these parameters in the Canto Web Publisher Pro / Internet Client Pro documentation.

Click on 'Configure...' to specify your Email Order System Pro attributes:

 
adminConfig
 
The Email Order System Pro Configuration
 

When opening this configuration for the first time, a basic initial set of parameters is displayed in the page. The parameters depend on the language selected (!), so if you have selected German as the language for the Admin Pages, you will find German settings. When saving the settings through the Admin Pages for the first time, a configuration file (filename: 'eosp8.properties') is created in the /temp/ directory of your Tomcat web application server.

After creating that file you can use the Admin Pages to change the settings or edit the configuration file 'eosp8.properties' with a text editor directly.

1) Serial Number: If you have a full version of the product, please provide your serial number (configuration file attribute EmailOrderSystemProSerialNumber).

2) Language: specify the language of your web application (configuration file attribute EmailOrderSystemProLanguage). (en_US = English, de_DE = German). Other languages can easily be added by creating the appropriate localisation files.

3) Email Template File: specify the email template file that is used to generate the email (configuration file attribute EmailConfigurationFile). You can find different template files in the folder '/EmailOrderSystemPro/config/templates'. If you would like to create your own email template file, put your version into this folder and specify the name of your file in this attribute.

4) Email Content Type: specify the content type (text or html) that is used to generate the email (configuration file attribute EmailContentType). Valid attributes are e.g. 'text/plain' (default) or 'text/html'.

5) Email Order Receipient: specify the email recipient address (the person who processes the orders) (configuration file attribute EmailOrderRecipient). You can specify one email address or a list of email addresses seperated by comma.

6) Use User Information: if you would like to use the additional information stored in the Cumulus User Manager (address information, etc.), set the attribute UseUserInformation to 'true'. This will automatically fill the fields in the order form with the information stored for the authenticated user in the Cumulus User Management (Cumulus $Users Catalog). Set the attribute to 'false', if the initial values of the order form fields should be empty.

Click on 'Save...' to create or update the configuration file. The file, that you can find in the /temp/ directory of your Tomcat web application server, will look like this:

 
config
 
The Email Order System Pro configuration file
 

All these attributes are valid for all the web applications using EOSP8 on your Tomcat web application server. The new configuration mechanism allows to specify configuration parameters for all web applications and all the users in all the Cumulus catalogs or you can specify different setups on a web application base or depending on the catalog that has been opened by the user. With this feature it is possible to use different languages in different web applications easily or for example you can have different Email Order Recipients for different Cumulus catalogs.

Here is an example configuration:

# --- Language used for messages: de_DE = German, en_US = English ---

EmailOrderSystemProLanguage=en_US
EmailOrderSystemProLanguage.catalog.Sample\ Catalog=en_US
EmailOrderSystemProLanguage.catalog.Beispielkatalog=de_DE
EmailOrderSystemProLanguage.webapp.Cumulus_Z=en_US
EmailOrderSystemProLanguage.webapp.Cumulus_D=de_DE

The example configuration above defines the English language as the standard for all order forms on this web server. But if the user opens the German web application 'Cumulus_D', the EOSP language is set to German. You can also define a language based on the opened catalog (see example: German 'Beispielkatalog').

Important: please note that the name of a attribute must not contain a space charater alone, as this character would seperate words from each other. It is important that you put a \ in front of every space in the attribute name (see example 'Sample\ Catalog') to glue the parts of the word together.

To specify these settings, you have to open the configuration file 'eosp8.properties', that you can find in the /temp/ directory of your Tomcat installation after using the initial setup of the EOSP Admin Pages. Please note that you can not set these parameters through the Admin Pages. Saving the settings through the Admin Pages will overwrite your additional settings in this file.

The order of using these configuration parameters is: web application settings, catalog settings and standard settings.


2.2 More Configuration Options

After the installation of the 'Email Order System Pro' there is a new folder 'EmailOrderSystemPro' in the folder 'Standard' of your web application. This folder contains the web pages that are displayed when the user accesses the 'Email Order System Pro' and it also contains all the basic configuration and localisation files:

File / Folder Description
EmailOrderForm.jsp Implements the first order form which enables the user to send an email containing a list of files. You can define mandatory fields inside the form by using a '_' at the beginning of a field name.
EmailOrderFormSelection.jsp Implements the second order form which enables the user to send an email containing a list of files, the number of files and format and additional information. You can define mandatory fields inside the form by using a '_' at the beginning of a field name.
SendEmail.jsp Checks first, if all mandatory field are filled by the user. If one or more mandatory fields are empty, the page 'Error.jsp' is display showing the name(s) of the empty field(s). If all mandatory field have been filled correctly (and the mail parameters are ok) the email is generated and sent.
EmailOK.jsp This page is displayed after an email has been sent correctly.
Error.jsp This page is displayed if an error occured while sending the email. Remark: the error message is stored in the implemented Email-Bean in English and German.
Stylesheet.css The Stylesheet that defines the used fonts, sizes and colors in the 'Email Order System Pro' pages.
pics Contains the images used for the 'Email Order System Pro'.
config Contains the configuration files, the email templates and the localisation files of the 'Email Order System Pro'.
admin Contains the Admin Pages that allow you to configure the 'Email Order System Pro' easily.
documentation Contains the documentation of the 'Email Order System Pro'. Open the file 'documentation.html' with a web browser to access this documentation.

After changing the context menu of the WPP/ICP Collection Basket by replacing the files 'CollBasketContextMenu.jsp' and 'CollBasketContextMenu.html', 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:

 
 
The first email order form
 

If you want to change the order form, open the file '...myTomcat/webapps/myWebApp/Standard/EmailOrderSystemPro/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:

 
 
You can specify the subject of the email
 

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 'Remarks'. If these fields are not available in your catalog, the fields in the File Selection section of the order form are left empty.

 
 
The second email order form
 


2.2.1 Definition of mandatory fields

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.

 
 
Names of mandatory fields begin with '_', example: '_Name'
 

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

 
 
The mandatory fields error page
 

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.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_en_US.txt' (or 'EmailTemplate_de_DE.txt'). This is the contents of the example file:

 
 
The contents of the English Email Template File
 

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 depend 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').

Placeholder Fieldname Description
[n*] n0 ... nn All field values in the form named 'n0' to 'nn' (Number of ordered files) will be inserted in the email in a new line.
[a*] a0 ... an All field values in the form named 'a0' to 'an' (Asset Names) will be inserted in the email in a new line.
[s*] s0 ... sn All field values in the form named 's0' to 'sn' (Selection values) will be inserted in the email in a new line.
[p*] p0 ... pn All field values in the form named 'p0' to 'pn' (Price) will be inserted in the email in a new line.

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

 
 
The contents of the email order - use 'Collect Files' to find and convert the files
 


2.2.3 The EOSP Tag Library

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 / Internet Client 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
getLocalText   Returns the localised text based on the localisation files in the folder 'localisation' and the language attribute set in the config file.
  key The key to find the text.
  fallback This text is returned if the key can not be found in the localisation file.
getUserFieldValue  Returns the value of the field from the $Users catalog specified in the attribute 'fieldName' for the current user.
  name The name of the $Users catalog field.
setLanguageSelected  Sets the selected language in an option list
  fallback The fallback language if no language is specified in the current session
getConfig  Returns the specified config parameter
  key The name of the config parameter
  overwrite The value can be overwritten by the specified request attribute
  platform The config parameter can be platform dependant
saveConfig  Saves the current configuration attributes
  enabled Saving the configuration can be disabled on a demo server
getVersion  Gets the version number of the EOSP product
ifAppStatusIs  Evaluates body if application status is correct
  status The status can be 'full' for full version or 'demo' for tryout version
getWebAppConfig  Returns the specified config parameter from the web.xml file
  key The name of the attribute inside the web.xml file
setSessionAttributes  Sets the Session Attributes
ifErrorIs  Returns body, if the given error id is the current error id
  errorID The error id to be compared
getCumulusError  Returns the Cumulus error message if available
getThumbnail  Gets the thumbnail from the record in the give size
  size The size of the thumbnail (e.g. 64 for 64x64 pixels)

 


2.2.4 Send Email Order in HTML format

In the Configuration File you can specify the Content Type of the email. If you set this property to 'text/html' (default is 'text/plain') the email will be sent in HTML format. This will allow to use formatting the text in the email order by using HTML tags.

 
htmlEmailOrder
 
The Email Order can also be sent in HTML Format
 

The product comes with two example Email HTML Templates (in English and German) that you can use as a start to develop your own HTML templates. You can find the files at 'myWebApp/Standard/EmailOrderSystemPro/config/templates'.

The files are named 'EmailTemplateHTML_en_US.txt' and 'EmailTemplateHTML_de_DE.txt'.

 

3 Finding the ordered files in the Cumulus Catalogs (Collect Files EJaP)

 

The Email Order System Pro comes with an application called 'Collect Files' for Mac OS X and Windows which helps to find the ordered files in the Cumulus catalogs. This application is based on the Canto EJaP (Embedded Java Plugins) technology. After installing the EJaP in the Cumulus Client (see chapter 1.2 Installation of the 'Collect Files' EJaP for details), a new menu item 'Email Order System Pro' is available to the user.

 
 
'Collect Files' helps to find the files in the catalog and it also performs the specified Asset Actions
 

With the application 'Collect Files' the user can verify, if all the ordered files are available in the Cumulus catalog. The 'Email Order System Pro' generates an email that holds a list of files with the Cumulus catalog name, the asset name, the unique RecordID, and the asset action (conversion) from the WPP/ICP collection basket. The values are seperated by semicolon.

This is what you have to do to process the order using the 'Collect Files' functionality:

1. Open the Cumulus Client and open the Cumulus catalogs necessary to process the order (you will find the names of the catalogs in the order email).

2. Open the application 'Collect Files' by clicking on the menu item 'Email Order System Pro>Collect Files...'.

3. Open your email application and the order email of your customer.

 
 
The list of ordered files in the email
 

4. Copy the list of ordered files from the Email into the 'Collect Files' textfield. The list contains the catalog names, asset names, the unique RecordIDs, and the asset actions, delimited by semicolon. If you have saved the list of order files to a text file, you can load this file by clicking the button 'Load File List'.

5. Start the search in the frontmost Collection by clicking the start button 'Start Search'. A search will be performed for the files in the frontmost Collection. You will get an error message if the frontmost collection does not contain all necessary catalogs.

6. All the found records will be displayed in the frontmost Collection and a search statistic will be displayed. A list of error messages will be displayed if some of the files could not be found in the Catalog. The frontmost Collection now contains all the found files. You can select all records in the Collection and assign appropriate metadata or copy the assets to a folder to prepare the files for shipment (by using Cumulus functionality).

7. Click the button 'Copy + Convert Files...' to use the asset actions provided in the email order. The files will be converted based on the asset action and copied to the selected folder.

 
 
The Collect Files configuration dialog
 

8. If you deselect the checkbox 'Use action while copying asset' the asset action is not used and just the original files are copied to the selected folder. The button title changes to 'Copy Files...'.

Remark: the language of the application 'Collect Files' depends on the current language of the Cumulus Client (English or German).

 

4 Miscellaneous

 

4.1 bcc: the email order

You can also send the email order as a blind carbon copy to a list of users. You can specify the bcc address in the form parameter 'bcc' in the email forms 'EmailOrderForm.jsp' and 'EmailOrderFormSelection.jsp'.

 
 
Specify a bcc address if needed
 


4.2 Show catalog name in email order form for Multi-Catalog Collections

The name of the catalog is displayed with every asset in the collection basket. This is necessary if you are working with a mult-catalog collection. The name of the catalog is not displayed if you are only using one catalog in the current collection.

 
 
The catalog names are displayed with every asset
 


4.3 Use Asset Actions to convert files

The email order also contains the asset action per file that has been specified by the user in the Collection Basket of WPP/ICP.

 
 
The email order also contains asset action information
 

The 'Collect Files' EJaP supports these 'Asset Actions'. In the example above, some of the files will just be copied into the specified folder, others will be converted to JPG before they are put into the specified folder.

 
 
Select 'Use action' to convert the files
before collecting the files in a folder
 

In the 'Collect Files' EJaP you can specify if you want to convert the files by using the specified Asset Actions, or not.

Important: please not that Canto does not support using the asset actions in EJaPs on Mac OS X in Cumulus Version 6. This function is only available to all Windows users (Cumulus 6 or 7) and to Macintosh users with Cumulus version 7.0 and higher.


4.4 Multi-Language Support

The Email Order System Pro supports English and German out of the box. The Cumulus Admin can add more languages, if necessary. All the text can be localised in localisation files and the language used in the order forms and emails can be specified in the configuration file.

The product comes with two localisation files:

- EOSP_en_US.properties (English)
- EOSP_de_DE.properties (German)

To add another languages just duplicate one of these files and localise the strings inside the file.


4.5 Auto-Fill order form with user information from Cumulus $Users Catalog (Server Console)

The Canto Cumulus User Management that is implemented in the Cumulus $Users catalog can hold a lot of information about the user. You can specify the additional user information in the Server Console User Manager in the 'Additional Fields' Tab. These user properties can be used by the Email Order System Pro in the email order form:

 
 
Specify the additional user info in the Cumulus Server Console to use it on the order form
 

If the configuration attribute 'UseUserInformation' is set to true (default), the information is automatically read into the Email Order form, so the user does not have to specify all the details with every order again and again. Of course the user is allowed to overwrite the information in the order form, if necessary.

 
 
The order form fields have been filled automatically based on the Cumulus Server users' properties
 

Please keep in mind that you can open the $Users catalog in the Cumulus Client to fill the additional fields in a quite comfortable way!

 


4.6 Disable save permissions on a Demo Server

The Cumulus / Email Order System Pro Administrator can enable or disable all functions that modifies the settings by setting an attribute inside the web application. This option is useful for sales partners to set up Email Order System Pro on a demo server.

You can disable all saving functionality in the page '/Standard/EmailOrderSystemPro/admin/switch.jsp' in line 14:

session.setAttribute("com.hc.eosp.writeEnabled", "true");

Set the value of the attribute to "false" to disable the saving of permissions.

 

 

5 Feedback & Support

 

Your feedback is very much welcome!

Please send all your questions about the product to the email address support@heymann-consulting.de. We try hard to answer your questions quickly and improve our products by implementing functionality based on your feedback.

Remark: we do not offer a telephone hotline for this product. Please send in all your requests by email.

 
 

6 Version History

 

Version 8.0.2 - May 2010

The version has been improved to better integrate into Modula4's WebModule product.

Version 8.0.1 - August 2009

The version fixes a bug that prevented to read the Cumulus Asset Names correctly, so the Email Order Forms did not transmit the Asset Name correctly.

Version 8.0.0 - June 2009

The version number of EOSP has been changed to 8 to adapt to the current version number of Cumulus. New features have been added to the Email Order System Pro and the technology has been modified and optimised for Cumulus 8. Find detailed information on the new features in chapter 0.2 Email Order System Pro Version 8.0 Enhancements - New Features.

Version 4.0.3 - February 2009

Two new web applications have been added for Cumulus WPP and ICP 7.6.

Version 4.0.2 - April 2008

The application 'Collect Files' has been optimised (new version 4.5) to work with Cumulus 7.5. The new EJaP now allows to load the list of ordered files from a text file. Also the user interface has been optimised to work with Cumulus 7.5 or higher. The web applications have not changed from version 4.0.1 to 4.0.2, so there is no reason to reinstall the web application!

Version 4.0.1 - September 2007

The new version comes with new web applications for Web Publisher Pro 7.5 and the Internet Client Pro 7.5. The application 'Collect Files' has been modified (version 4.0.1) to work with Cumulus 7.5 concerning some localisation issues.

Version 4.0.0 - November 2006

The new version comes with a lot of new feature in the web application and the Collect Files EJaP. This version is an implementation for Cumulus 6.6/7.0 and the Web Publisher Pro 3.0/7.0and the Internet Client Pro 3.0/7.0 with web applications in 3.0 design.

Version 3.0.0 - September 2005

The new version is an implementation of the Email Order System Pro technology for Cumulus 6.6 and the Web Publisher Pro and the Internet Client Pro.

Version 2.0.1 - April 2005

The new version supports to send the order email in HTML format. The administrator is able to specify the content type as a mail parameter ('text/html').

Version 2.0 - Dezember 2004

The new version is an implementation for the Cumulus 6 Web Publisher Pro 2.0. The 'EmailOrderSystemPro' web application is an extension to the WPP 2.0 web application shipped with Cumulus 6! It implements a new serial number technology. The serial number is now part of the configuration file 'web.xml'. The software ships with a new 'Collect Files' application based on Canto's EJaP (Embedded Java Plugins) technology introduced with Cumulus 6. The encoding for the email text is now a configurable attribute.

Version 1.1 - July 2003

The new version implements a second Email Order Form which enables the user to select the number of ordered files and their format from a selection box. It is also possible to display pricing information direct from the Cumulus catalog fields.

Version 1.0.1 - July 2003

An error message was displayed when a user, who logged in as 'guest' (no username and password), tried to send an email order. If the user is logged in as 'guest', now the 'Email Order System Pro' will use the name configured in the attribute 'guestName' of the TAG 'getUserName' for the user name.


Please send all your questions about the product to the email address support@heymann-consulting.de. We try hard to answer your questions quickly and improve our products by implementing functionality based on your feedback.


Email Order System Pro
©2003-2010, Heymann Consulting