©2010-2011, Heymann Consulting | |
Email Order System Pro (EOSP) for Cumulus Sites - Version 8.1.1 |
Documentation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Documentation Version: 8.1.1.4 last modified: 2011-10-12 |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Contents | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
0.1 Tryout Version
1.1 Simple Installation
2.1 Basic Configuration (Admin Pages) 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 Sites web access solution. With the help of this extension, the user of the Cumulus Sites web application 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 additional functions for the Cumulus Client (for Mac OS and Windows) which helps to find the ordered files in the Cumulus catalogs. The EJaP (Embedded Java Plugin) 'CollectFiles' also allows to use 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 for example used by print service providers.
Two new buttons in the Cumulus Sites Collection Basket provide access to the order forms: 'Order Basket' and 'Order Basket with Selection'. The 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 localization files easily! EOSP uses the Cumulus Sites mechanism to set the user's language: it takes the preferred language which is configured in the user's web browser. A fallback language can be configured if the user's browser is set to a language not supported by EOSP.
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 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. 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, please 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. Remark: the full version serial number is a Cumulus Option serial number that must be added to serials in the Remote Admin of the Cumulus Server Console! Add the serial number to the list of serials in the license dialog of the Remote Admin and get a new Activation Key from the Canto website for your Cumulus environment. 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... A very special thank you goes to Albert Riera and Ferran Sogas from Microgestió, Barcelona, who provided the Spanish translation files.
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
1 Installation | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
The System Requirements of the Email Order System Pro product follow the system requirements of your Cumulus Sites 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. You will find all the files that are necessary to integrate into your web application inside the 'Installation' folder of the 'EmailOrderSystemProSites' product folder. IMPORTANT: Please keep in mind that EOSP for Sites is designed to work with Cumulus Sites only. It is not designed to work with any other Canto web technology. There is a seperate product for the Cumulus Web Publisher Pro or Internet Client Pro available. After the standard installation of Cumulus Sites you will find the Cumulus Sites web application inside the folder 'Sites' inside the folder 'webapps' of your Tomcat application folder. This is what you have to do to install EOSP for Sites: 1. Stop your web application server Tomcat. If you are using Cumulus Sites 8.5 and later please install the files from folder /Installation/eospSites-8-5-0 as described in the documentation. If you are using an earlier version, please install the files from folder /Installation/eospSites-8-1-1. After copying the folder the contents of the Sites 'customizations' folder will look like this:
If you already have an older version of 'eospSites-8-x-x installed, please read chapter 1.3 Update your EOSP for Sites version. 3. Restart your web application server Tomcat. When restarting Tomcat, the Cumulus Sites technology will copy all the EOSP product files from 'customizations/eospSites-8-x-x' into the appropriate folders. It copies .jspx files, libraries and other files into specified folders. After the first restart of Tomcat the files are just copied into the appropriate folder, but they are not visible to Tomcat, so another restart is necessary to use the new functions, so ... 4. Restart Tomcat for a SECOND time to make all the files visible to the Tomcat web application server. 5. Configure the EOSP for Sites attributes by opening the URL http://myServer(:8080)/Sites/EmailOrderSystemPro/admin Remark: the standard name of the Cumulus Sites web application is 'Sites'. The name of the web application may vary depending on your configuration. Log into the web application as Cumulus Administrator to change the configuration to meet your needs as described in chapter 2 Configuration. Please make sure that your SMTP Server setup is correct to allow sending emails. The following parameters are necessary to let the system send emails: That's it! Now you can put some files into the Collection Basket and use the email order forms to send the order email. 1.2 Add the EOSP for Sites product full version serial number The full version serial number is a Cumulus Option serial number that must be added to Cumulus serials in the Remote Admin of the Cumulus Server Console! Add the serial number to the list of serials in the license dialog of the Remote Admin and get a new Activation Key from the Canto website for your Cumulus environment. This is what you have to do: For Cumulus 8.5.x (or later) users If you are using Cumulus 8.5 and later you have to use the Cumulus Remote Admin web pages to add the full license serial number to your current Cumulus Server serial numbers. 1. Open the following URL in a web browser on the Cumulus Server: http://localhost:8954/login.html 2. Login as Cumulus Administrator. 4. Click 'Edit License' and add your EOSP for Sites product serial number to the list of serial numbers. 5. Click 'Register with Canto via WWW' to get a new Cumulus Activation Key that also unlocks the EOSP product. The license dialog should indicate an unlimited number of Clients for the EOSP for Sites product after adding the new Activation Key. For more information on how to add a serial number to the Cumulus Option serials using the Remote Admin web pages, please consult the Canto Cumulus manual (chapter Remote Admin via Web Browser). For Cumulus 8.0.x and 8.1.x (or later) users 1. Open the Cumulus Client. 2. Select 'File>Administration>Server Console'. 3. Login as Cumulus Administrator and select 'Remote Admin>License' 4. Click 'Edit License' and add your EOSP for Sites product serial number. 5. Click 'Register via WWW' to get a new Cumulus Activation Key that also unlocks the EOSP product. The license dialog should indicate an unlimited number of Clients for the EOSP for Sites product. For more information on how to add a serial number to the Cumulus Option serials, please consult the Canto Cumulus manual. 1.3 Update your EOSP for Sites version To update your 'Email Order System Pro for Sites' installation, you just have to remove the older EOSP product folder and replace it with the new version in the 'customizations' folder of your Sites web application. Here is an example how to update EOSP 8.1.0 with version 8.1.1: 1. Remove the folder .../Cumulus Sites/apache-tomcat-6.0.x/webapps/Sites/customizations/eospSites-8-1-0 (keep it as a backup!) 2. Copy the new product folder 'eospSites-8-1-1' to .../Cumulus Sites/apache-tomcat-6.0.x/webapps/Sites/customizations/eospSites-8-1-1 3. Please also delete the corresponding subfolder that belongs to your web application folder (folder with the same name in /work/Catalina/localhost) inside the 'work' directory of your Tomcat installation to make sure, that all pages of your web application are refreshed. 4. Restart Tomcat 2(!) times. After the second restart of Tomcat your Sites web application will show the new functionality. To uninstall the 'Email Order System Pro' from your Cumulus Sites installation, you just have to remove the 2 EOSP product folders from your Sites folder: .../Cumulus Sites/apache-tomcat-6.0.x/webapps/Sites/customizations/eospSites-8-x-x After a restart of Tomcat your Sites web application will show its orginal behaviour. 1.5 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/CollectFiles'. Copy the 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 Client\ejp', under Mac OS X it is 'Macintosh HD/Applications/Cumulus 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! |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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: 'eosp8Sites.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 '/temp/eosp8Sites.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)/mySites/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.
The Basic Configuration Page displays information about your current web application settings (like product serialisation and Mail Server Settings).
The mail server settings are read from the EOSP configuration attributes. In the screenshot above these parameters are not set, make sure that they are set properly to allow sending emails. Click on 'Configure...' to specify your Email Order System Pro attributes:
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 initial German settings. When saving the settings through the Admin Pages for the first time, a configuration file (filename: 'eosp8Sites.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 'eosp8Sites.properties' with a text editor directly. 1) SMTP mail host: specify the SMTP mail host to connect to for sending any emails (configuration file attribute SMTPHost). 2) SMTP Port: you can leave the parameter empty, if you do not use SSL technology, EOSP will use the standard SMTP port in this case. 3) SMTP Security: if your mail server is using SSL technology, select 'Secure SMTP (SSL)'. Please specify the port that you have to use. E.g. if you use 'googlemail', the port is 465. 4) SMTP user name: the user name for the SMTP server authentication (configuration file attribute SMTPUsername). 5) SMTP password: the password for the SMTP server authentication (configuration file attribute SMTPPassword). 6) Sender Email: specify the e-mail sender address of any e-mail sent out by the Email Order System Pro (configuration file attribute SenderEMail). 7) Language: specify the language of your web application (configuration
file attribute EmailOrderSystemProLanguage). (en_US
= English, de_DE = German, es_ES = Spanish). Other languages can easily be added by creating the appropriate localization files. Click on 'Save Configuration' to create or update the configuration file. The properties file, that you can find in the /temp/ directory of your Tomcat web application server, holds the parameters of your configuration. All these attributes are valid for all the web applications using EOSP for Sites 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 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 'eosp8Sites.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' inside your web application folder and some modifications are made to original Cumulus Sites files in the main folder. Here is a list of the important files and folders:
When Tomcat is restarted, the copy mechanism of Cumulus Sites will copy the folder 'EmailOrderSystemPro' into the Sites' main folder and will also perform some modifications of original files based on XSLT. For example, one xslt stylesheet will add the EOSP buttons to the Collection Basket page, another one will add a load function for the EOSP application to the Sites.jspx file. The order forms can be accessed in the Collection Basket page by clicking one of the new email order buttons:
If you want to change the order form, open the file '...myTomcat/webapps/mySites/eospconfiguration.jspx' with a text or HTML editor. Please note that one parameter of the order form sets the subject of the email. The hidden parameter 'Subject' sets the subject of the email in the file 'eospconfiguration.jspx' in line 153:
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.
2.2.1 Definition of mandatory fields You can define mandatory fields in the email form very easily. The technical name in the form of mandatory fields start with a '_' character, so just insert this character at the beginning of the field name to require a value. The 'Email Order System Pro' will check all mandatory fields before the email is generated. In order to display the name with a "*" sign on your page in order to indicate to the user that this is a mandatory field simply add the "*" after the placeholder for the field name. For example: The following error message 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 message. Remark: if you change a field name in the order form ('eospconfiguration.jspx' or 'eospselectionconfiguration.jspx'), 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' for a German email). 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 a placeholder to insert the date and time into the email. The placeholder for the default server date format is [$DATETIME$]. You can add a locale to the parameters to get the value in the desired local format. For example $DATETIME_DE$ will return the current date and time in a German format or $DATE_en_US$ will return the date in a US English format. So it is possible to specify the format that should be used by providing Java Date and Time Patterns. You can just add a valid Java Date and Time Pattern after the '_' character. Find more information on Java Date and Time Patterns here on the Java Website. If the pattern is not valid the server's default date and time formats are used. The Selection Area at the end of the Email Template file is used for the second email form (eospselectionconfiguration.jspx). 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 JSPX format) and a TAG library that enhances the functionality of Cumulus Sites. The Tag library consists of the following TAGs:
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; charset=UTF-8' (default is 'text/plain; charset=UTF-8') 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 'mySites/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.
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. 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'. 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 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 | |||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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 'eospconfiguration.jspx' and 'eospselectionconfiguration.jspx'.
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 localization files and the language used in the order forms and emails can be specified in the configuration file. The product comes with three localization files: and a fallback file 'eosp.properties'. 4.4.1 Add a new language to the product To add another language (French in this example) to the product, please follow these steps: 1) Duplicate the English localization file '.../Cumulus Sites/apache-tomcat-6.0.x/webapps/Sites/customizations/eospSites-8-x-x/WEB-INF/classes/resources/bundles/eosp_en.properties' and rename it 'eosp_fr.properties' in that folder. The naming convention for the file uses the country code after the '_' character. 2) Translate the contents of the file. After a restart of Tomcat the new translations will be available to EOSP. If you are using French in your Web Browser settings, you will get the order forms in French now. 3) If you want to translate the order email into French either, duplicate the template file '.../Cumulus Sites/apache-tomcat-6.0.x/webapps/Sites/customizations/eospSites-8-x-x/EmailOrderSystemPro/config/templates/EmailTemplate_en_US.txt' and rename it 'EmailTemplate_fr_FR.txt' in that folder. Translate the Strings in the file into French, but not the variables in the brackets '[]'. 4) Log into the EOSP Admin and set the Email Template File setting to 'EmailTemplate_fr_FR.txt'. You can also set the standard language setting of the product to 'fr_FR', if you like. After saving the settings and a restart of Tomcat, which will copy the files from the customizations folder into the main directory, the next order email will be sent in French. 5) If you want to send the email orders in HTML format, apply steps 3) and 4) to '.../Cumulus Sites/apache-tomcat-6.0.x/webapps/Sites/customizations/eospSites-8-x-x/EmailOrderSystemPro/config/template/EmailTemplateHTML_en_US.txt'. 6) To use the new language in the admin area, you just have to login into the admin pages with the appropriate web browser settings. If you want to set the language for the admin pages explicitely, use the following URL to log into the admin area: http://myServer(:8080)/Sites/EmailOrderSystemPro/admin/login.jsp?lang=fr If you have created the localization files, we would be happy to add these to our product. Please just send the files to us by clicking here and we will make sure that your translation is part of the next product. 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!
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. 4.7 Show Thumbnails in the Order Form The 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'. In the example below, the size attribute is set to 64 pixels.
4.8 Email Subject configuration The email subject can be configured in the localization files of EOSP. All the text can be localized in localization files and the language used in the order forms and emails can be specified in the configuration file. The product comes with three localization files: and a fallback file 'eosp.properties'. To modify the email subject just find the entry named 'EOSP.EmailOrderForm.Subject'. 4.9 Remove one of the order forms For some customers, only one of the order forms is relevant and they do not want to use the other. This is how you can remove one of the forms: 1. Open the file /customizations/eosp-8-x-x/collectionbasketview.jspx.xslt
2. Remove the marked block to remove icon 1 or icon 2 (see screenshots).
3. Restart Tomcat to deploy the modification. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
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.1.1 v1- June 2011 The email order contentType has been set to 'text/plain; charset=UTF-8' to support special characters in all the email applications. Version 8.1.1 - June 2011 This release comes with an implementation for Cumulus Sites 8.0.x, 8.1.x (installation folder eospSites-8-1-0) and another one for Cumulus Sites 8.5 (installation folder eospSites-8-5-0). The implementation for Cumulus Sites 8.5 also supports the new Sites' 'themes' technology. This new version also supports Spanish in the order forms, the EOSP Admin section and the email templates. A new function to allow Java Date and Time patterns was added to support Spanish date and time format in the email orders. It also fixes a localisation bug and a problem with the selected Asset Action on Mac OS X servers. Version 8.1.0 v4 - May 2011 This update allows the Administrator to configure the Email Subject. Version 8.1.0 v3 - January 2011 This update contains some minor modification that have to do with empty records in Cumulus Catalogs. Since version 8 of Cumulus it is possible create empty records, that obviously do not have a thumbnail or an Asset Name in the beginning. EOSP for Sites now supports these empty records. A problem with Asset Names containing the character " (quotation mark) has been fixed. Version 8.1.0 v2 - January 2011 This update contains a minor modification that fixes a bug that slowed down the display of the order form. The old version tried to get the catalog names of the records by analyzing all records in the current collection (which might be in worst case all records in all catalogs). In this new release the catalog names are read from the records in the collection basket, which is much faster (of course). Version 8.1.0 v1 - December 2010 This update contains a minor modification that was necessary to use SSL when sending emails through EOSP for Sites. Version 8.1.0 - November 2010 This version of the Email Order System Pro is the first version for the Cumulus Sites product. The product is based on the Email Order System Pro product that has been out on the market since 2003 in different versions for various Cumulus web applications.
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 | |
©2010-2011, Heymann Consulting |