| ©2003-2008, Heymann Consulting |
|
| Email Order System Pro - Version 4.0.2 | |
| Documentation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| Contents | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
0.1 Tryout Version 1.1 Simple Installation 2.1 Definition of mandatory
fields 3 Finding the ordered files in the Cumulus Catalogs (Collect Files EJaP)
4.1 bcc: the email order | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 0 Introduction | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 (shipped with Cumulus 6) and WPP/ICP 7.0/7.5 (shipped with Cumulus 7/7.5) with '3.0 Design' web applications. 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! 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 tryout version of the 'Email Order System Pro' is a full version of the product, so you can test all the functionality available.
The limitation: the order form will show a demo info and a link to our website. Also the order email shows the demo information. 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 product, send an email to Heymann Consulting. 0.2 Email Order System Pro Version 4.0 Enhancements The Email Order System Pro version 4 comes with a lot of enhancements to make life of the Cumulus Administrator easier. Click here to see a detailed documentation of the new features of version 4. A special thanks to all who have contributed to the development and improvement of this product. Thank you very much to 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 the 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). For installation, you can just copy the example web application into your tomcat 'webapps' folder (see 1.1 Simple Installation for details) or copy single pages into your current Cumulus web application (see 1.2 Integration into an existing web application). To install the software you only have to copy the file 'EmailOrderSystemPro4_XXX.war' or the German version 'EmailBestellsystemPro4_XXX.war' developed for your version of WPP/ICP (you will find it inside the 'Web Applications' folder) into your Tomcat web application folder ('.../myTomcat/webapps'). The file will be automatically unpacked by a running Tomcat application to a folder 'EmailOrderSystemPro4' (or 'EmailBestellsystemPro4'). The Email Order System Pro example web applications are modified Cumulus Web Publisher Pro 3.0/7.0/7.5 or Cumulus Internet Client Pro 3.0/7.0/7.5 web applications. Please use the appropriate web application for your WPP/ICP installation. You will find the name of the '.war'-file for your version of the WPP/ICP in the following table:
The web application is the Cumulus standard web application containing
all the Email Order System Pro technologies. To make the web application
work with your email server configuration please specify your email
server parameters in the Canto configuration file '/EmailOrderSystemPro4/WEB-INF/web.xml',
as usual. Here are the parameters to be specified: If you have already configured these attributes in another web application, you can just copy and paste the 'web.xml' file from there. After restarting your Tomcat web application server you can access the site e.g. via 'http://myServer:8080/EmailOrderSystemPro4_WPP/' (if your Tomcat is using TCP/IP port 8080 for communication). The pages inside the folder are the files of the current Cumulus Web Publisher Pro / Internet Client Pro with the pages and functions of the 'Email Order System Pro' included. 1.2 Integration into an existing web application You will find all the files that are necessary to integrate into your web application in the example web application of the Email Order System Pro. Please find detailed information on how to install the example web application in chapter 1.1 Simple Installation. After the standard installation of Cumulus WPP 3.0 you will find the standard Cumulus web application inside the folder 'Cumulus' (English version) or 'Cumulus_D' (German version) inside the folder 'webapps' of your Tomcat application folder. If you are using WPP 7.0/7.5, 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. Inside the folder you will find the folder 'Standard', which is the standard appearance of the WPP/ICP. In this folder you have to make the changes to implement the 'Email Order System Pro'. If you are using the English version, copy the files from the folder 'EmailOrderSystemPro4', if you are using the German version, you will find the files in the folder 'EmailBestellsystemPro4'. Please not that the folder name depends on your WPP/ICP version, e.g. 'EmailOrderSystemPro4_WPP' for WPP 3.0 and Cumulus 6. 1. Stop your web application server Tomcat. 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.3 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 introduced with Cumulus 6. In the product folder you will find a folder 'Collect Files EJaP' which contains two sub-folders: 'for Cumulus 6 or 7' and 'for Cumulus 7.5 or higher'. Open the folder that matches your installed Cumulus version. Remark: only use the version for Cumulus 7.5 if you have a Cumulus version 7.5 or higher installed! In the folder, you will find a sub-folder 'CollectFiles'. Copy this sub-folder ('CollectFiles') into the 'ejp' folder in the installation folder of your Cumulus Client application. Under Windows it is e.g. 'C:\Program Files\Canto\Cumulus 7Workgroup Client\ejp', under Mac OS X it is 'Macintosh HD/Applications/Cumulus 7 Workgroup 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! |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 2 Configuration | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 configuration files:
All the configuration can be done in the Email Order System Pro configuration file '.../Standard/EmailOrderSystemPro/config/EOSP4.properties':
1) Please open the file 'EOSP4.properties' with a text editor. After changing the context menu of the WPP Collection Basket as described in the chapter 1.2 Integration into an existing web application (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:
If you want to change the order form, open the file '...myTomcat/webapps/EmailOrderSystemPro4/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.
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.
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:
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'. 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 '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').
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 / Internet Client Pro. The Tag library consists of the following TAGs:
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. 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 'EmailOrderSystemPro4/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 introduced by Canto with Cumulus version 6. After installing the EJaP in the Cumulus Client (see chapter 1.3 Installation of the 'Collect Files' EJaP for details), a new menu item 'Email Order System Pro' is available to the user. Remark: there are two different versions of the Collect Files EJaP. One version supports Cumulus 6.6 and 7.x and the second version supports Cumulus 7.5 or higher. Please make sure that you have installed the appropriate version for your Cumulus installation (see chapter 1.3 Installation of the 'Collect Files' EJaP for details).
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).
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.
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).
8. If you deselect the checkbox 'Use action while copying asset' the asset action is not used and just the original file is copied to the selected folder. The button title turns 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
|
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'.
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.
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 '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.
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. 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: 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:
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.
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! |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
| 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 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.
|
| Email Order System Pro | |
| ©2003-2008, Heymann Consulting |
|
