eRez Imaging Server - Cumulus Integration Guide
January 3, 2007
Copyright 2001-2007 YaWah.com. All Rights Reserved
Before the release of eRez Imaging Server 4.0 there was a separate product called “ImageExpress for Cumulus” which was a special version of eRez Imaging Server licensed for integration with Canto Cumulus 6 Web Publisher Pro (WPP) or Cumulus 6 Internet Client Pro (ICP).
This product is now discontinued and the “Cumulus Integration” described in this document comes with all versions of eRez Imaging Server.
The Cumulus Integration adds 3 new items to the context menus in WPP and ICP for all assets which can be recognized and handled by the eRez Imaging Server.
A direct link between WPP/ICP and eRez ensures that the extra menu items are only displayed after it has been verified that the asset is available and supported by eRez.
Source files can either be stored in regular folders accessible by eRez or in one or more Vault folders accessible by eRez.
The Cumulus Integration adds the menus “View”, “Download” and “Publish to Web” to the context menus in WPP and ICP.
The new menu items are:
The View function brings up a HTML or Flash based viewer which users to zoom in, rotate and examine details of high resolution images, requiring no more than a regular dial-up connection.
The Flash based FSI Viewer
The download function adds high quality image conversion with advanced options for rotation, cropping and more. Images can either be downloaded individually or as a batch of images. Images are ZIP compressed on-the-fly as they are downloaded.
The download function adds high quality image conversion with advanced options for rotation, cropping and more
For more information about download options, please refer to the built in online help system.
A quick link to the eRez Download Manager is added next to the Collection Basket in WPP/ICP.
The new Publish to Web function can be used to publish zoomable dynamic images to external web pages either as pure HTML or Flash based viewers.
Special effects such as watermarking and overlays can be added on the-fly without modifying the source image. For more information about Publish to Web, please refer to the built in online help system.
The new Publish to Web function can be used to publish zoomable dynamic images to external web pages.
eRez Imaging Server 3.0 is fully backwards compatible and works perfectly with the ImageExpress 2.x integration for WPP 1.0 and WP “classic” which are still available for download at www.yawah.com.
Further, the modifications included with the Cumulus Integration 3.0 can easily be adapted to earlier versions of WPP and ICP, although this has not been tested and will not be supported.
Beside adequate hardware you will need the following to install and operate The Cumulus Integration 3.0:
There are several ways that the Cumulus Integration can be installed:
If you already have WPP/ICP installed and running you can install eRez to the same Tomcat server by using the WAR files from the eRez “All Platforms” package.
Basically you will have to place the two WAR files “erez4.war” and “erez4admin.war” in the “Cumulus 6 Web Publisher Pro\jakarta-tomcat-4.1.30\webapps” directory, increase the maximum heap size of the Tomcat server and restart the Tomcat server. Please refer to the eRez “Installation Guide” for the details.
You can also choose to install eRez using a separate Tomcat Server on the same machine. This allows you to take advantage of the preconfigured and optimized Tomcat 5 server and scripts/programs that comes bundled with eRez 3.0 for Windows and Mac OS X. Another benefit of this setup is that you can shut down one of the two servers for maintenance without affecting the other.
In this scenario you will either have to configure the second Tomcat to use different port numbers or use a separate IP number.
The standard ports that you need to change when using the same IP number is 8005, 8009 and 8080.
You can have both WPP/ICP and eRez indirectly listen on the standard HTTP port 80 by having an Apache or IIS web server acting as a front end connected to the two Tomcat servers via AJP13.
For details on how to configure Tomcat, please refer to the Tomcat documentation on the Tomcat web site: http://jakarta.apache.org/tomcat/
A straight forward solution is to install eRez on a separate server in the network. This way there will be no competition for port numbers and resources between the two applications.
No matter which of the 3 configurations you decide on, you must make the folders with assets and Vault folders (if any) directly available to the eRez server via the file system. If the assets are stored on a server other than eRez, the directories holding the assets must be mounted on the server running eRez using SMB, NFS or similar, so that eRez can read the files directly.
The installation of the Cumulus Integration can be divided into 5 steps:
To install WPP or ICP please refer to the Canto documentation.
To install eRez, please refer to the eRez Imaging Server documentation and the notes about server configuration.
For the Cumulus Integration to work the assets must be available from both Cumulus WPP/ICP and the eRez Imaging Server. That means, that
When the assets are ready and available in both WPP/ICP and eRez we can install the Cumulus Integration integration files in WPP/ICP. The files can be found in the same folder as this document (erez4/cumulus integration).
For WPP this is done by these steps:
For ICP this is done by these steps:
Next shut down and restart the Tomcat server.
It is highly recommended that you run the Tomcat server in the foreground during the following configuration using either jakarta-tomcat-4.1.30\binstartup.bat or jakarta-tomcat-4.1.30\binstartup.sh depending on your operating system. This will allow you to immediately read the debug output from the eRez integration module and ease the configuration.
When the Cumulus Integration files are correctly installed you will see a link to the eRez Download Manager on the top of the WPP/ICP page:
In addition you will see a lot of debugging information being written to the Tomcat console whenever you click on a thumbnail.
The final step is now to configure the integration by editing the XML file “Cumulus 6 Web Publisher Pro\jakarta-tomcat-4.1.30\webapps\Cumulus\WEB-INF\erez-config.zml” or “Cumulus 6 Internet Client Pro\jakarta-tomcat-4.1.30\webapps\CumulusE \WEB-INF\erez-config.xml” depending on which version you are using.
You can edit this file while both eRez and WPP/ICP are running and you don’t have to restart either of the servers for your changes to take effect.
You can edit the file using a standard text editor such as Wordpad on a Windows system.
The file contains 3 sections that need to be edited:
The first section deals with the eRez server and looks like this:
You will need to edit the 4 values.
The next section turns the debugging information on and off.
You can change the value of “debug” to “false” after the configuration is completed to stop the debug output. The attribute “encrypt” controls whether eRez source paths sent to the clients browser is encrypted or not (since eRez version 4.0.6). Change this to false in order to disable encryption.
Please note that paths to files stored in Cumulus Vault are not encrypted.
The final section defines the mappings used to translate the asset locations from the Cumulus Catalog to eRez paths. A cumulus can hold 4 different types of asset locations: Windows, Macintosh, UNIX and Vault. Each type holds a reference to a file or Vault location in a format specific to the type.
The erez-config.xml that comes with the Cumulus Integration has 4 sample mapping predefined:
<map type="windows" path="C:\Program Files\yawah\erez4\tomcat\webapps\erez4\WEB-INF\sample images\" erez-path="Samples/" />
<map type="mac" path="Somewhere:my stuff:images:" erez-path="New Pictures/" />
<map type="unix" path="/var/somewhere/images/" erez-path="Strange images/" />
<map type="vault" path="Wintermute:9287" erez-path="vault" />
<map type="vault" path="localhost" erez-path="vault" />
The first example maps Windows reference to files or folders inside “C:\Program Files\yawah\erez4\tomcat\webapps\erez4\WEB-INF\sample images\” to the eRez shared folder “Samples/”. Please note the last “\” and “/” in the paths. This means that all request for a Windows file located in that directory or in a subdirectory below that point is mapped to the specified eRez shared folder.
The next two examples shows similar mappings for Macintosh and UNIX references.
The final two examples shows two examples for mapping Vault entries using either “Wintermute:9287” (host and port number) or “localhost” (only port number). The eRez shared folder “vault” has been defined as the root folder of the corresponding Vault storage.
You must add as many mapping as necessary to have all your asset references mapped correctly. It is not always immediately obvious what the exact references looks like in a Cumulus Catalog – so you may need to look at the debug output to see exactly what kind of paths that needs to be mapped.
For paths containing server names and shares (for example \\HUBBA\dyt\images\canto.tif” you must specify the complete path including server and share names.
This chapter explains the details of what happens when a user click on a thumbnail in WPP/ICP to display the context menu.
When the debug information is enabled you will be able to follow these steps on the Tomcat console when the Cumulus Integration code is invoked.
1) First a connection to the integration classes is established from the JSP page. This will reload the configuration file if it has been changed since it was last used or have not been used before.
2) Next the JSP page runs through all available Asset References in the Cumulus Catalog for the asset.
3) For each of these a request for mapping is handled to the integration classes. If a matching “map” is found, the path is mapped and URL encoded. Next the availability of the asset is verified by sending a request to the eRez server. If the asset is available the URL will be used and no further Asset References are processed.
4) Using this URL the links to eRez are written to the menu HTML code.