eRez Management Console - Online Help

Copyright 2001-2005 YaWah.com. All rights reserved.

Version 3.2 – 11-nov-2005

Table of Contents

Overview.

System Settings.

Roles.

Users.

Shared Folders.

Real-Time Templates.

Download Templates.

Installing Packages.

Licenses, Copyrights and Disclaimers of Bundled Third Party Products

 

Overview

The eRez Management Console allows a user with administrator privileges to configure and administrate the eRez Imaging Server from a remote computer on the network. The initial configuration of the server as well as the day-to-day administration of user accounts, image templates and shared images can easily be done without having to modify the XML configuration files directly.

Apart from a few infrequently used settings all eRez options can be configured and managed from the eRez Management Console. All parts of configuration can still be made by editing the XML files directly as described in the eRez documentation. The eRez Management Console works by editing the XML files in the same way that you can do manually. The eRez Management Console is implemented as a stand-alone web application and it can easily be disabled by simply removing the “erez3admin” web application from the server.

The eRez Imaging Server scans the configuration files for changes every 10-30 seconds, so you must allow up till 30 seconds for your changes to take effect.

Before you can use the eRez Management Console you must login as a user with “Administrator” privileges.

Note: Some of the default settings for paths to directories and files use the “magic” name “WEB-INF” as the start of the path like “WEB-INF/sample images/cms”.  If the path starts with “WEB-INF” it will be substituted with the path to WEB-INF directory of the erez3 web application. For example: “C:\Program Files\yawah\erez3\tomcat\webapps\erez3\WEB-INF” on a Microsoft Windows system. The default values are set to directories inside this directory in order for the eRez server to work immediately after it has been installed. It is recommended that you place your own files in separate directories outside the erez directory.

System Settings

This panel is used to configure some of the basic settings for the server. These settings are normally configured when the software is first installed and are seldom changed after that.

Note: Unlike the rest of the panels, these settings require the server to be restarted in order for all changes to take effect.

Field

Description

Public URL

The public URL of the eRez sever such as “http://erez.yawah.com/erez”. This URL is used when creating emails and building HTML page with the URL Builder.

Enable e-mail Sending

In order for the eRez server to send emails this box must be checked. By default this is disabled when the server is first installed.

SMTP Server

The hostname or IP address of the outgoing SMTP server.

Default e-mail from

The default from address when the eRez server sends an e-mail.

Default e-mail reply to

The default reply-to address when someone replies to an e-email generated by the eRez server.

Copy all mail to

An optional e-mail address to which “blind carbon copies” are sent of all e-mails.

Administrator's e-mail

The e-mail address for the Administrator. If this is set to a valid email address then an email is sent to that address when the server is started and when an error requires immediate attention.

Number of Real-Time Imaging Threads

The maximum number of concurrent image processing operations for real-time images. The default value is 2. The optimal setting depends on the number of CPUs and available memory on the server.

Number of Download Imaging Threads

The maximum number of concurrent image processing operations for high resolution images. The default value is 1. The optimal setting depends on the number of CPUs and available memory on the server. You should allocate a minimum of 128MB RAM per thread to the Java Virtual Machine.

Maximum Cache Size (Mb)

The maximum size of each cache in mega bytes. The server will check each cache every 5 minutes and delete the least recently used images until the total size of the images is equal or less this value.

Maximum Size of "flat" images (Mb)

Specifies the maximum uncompressed size in Mb allowable for a single-resolution image such as JPEG. The default value is 4 Mb and you should only increase it if you have a very powerful server with lots of memory.

Temporary Download Storage

The path of a directory to temporarily hold the processed images and ZIP files. The default value "WEB-INF/download" is set in order for eRez to work immediately after installation - but it is recommended to change this to a directory outside the "erez2" directory.

Temporary Upload Storage

The path of a directory to temporarily hold uploaded files. The default value "WEB-INF/upload" is set in order for eRez to work immediately after installation - but it is recommended to change this to a directory outside the "erez2" directory.

Hot Folder Pause Length

The number of seconds to wait between each scan for changes to the shared folders. The default value is 10 minutes is (600 seconds).

Metadata Cache Size

The maximum number of images to cache metadata for in memory. eRez will keep an up-to-date copy of the metadata for the most recently used images in RAM to increase the performance for frequently used images.

System Passphrase

Used to override the secret password used by eRez to build special URLs for use with slideshows and showcases for non-public folders and queries.

Roles

Roles are simple names used to assign privileges to individual users. For instance you can create a role named “resellers” and specify that only users assigned the role of “resellers” can download images from a specific shared folder. This way only users assigned the “resellers” role (and administrators) can download images from that specific folder. In the technical documentation roles are also referred to as “groups” – but the term “roles” better explains how they are used.

Users

This is where you define the individuals or or special accounts like “guest” that you want to be able to log on to the eRez Imaging Server.

Field

Description

Login

The user’s “handle” or initials used to log onto the system.

Password

The user’s password.

First Name

The user’s first name.

Last Name

The user’s last name.

Email Address

The user’s e-mail address.

Roles

The roles assigned to the user. Hold down the CTRL-key to select/deselect multiple roles.

Administrator

Assigns “Administrator privileges” to the user. When this is checked the user will be assigned all roles and will be allowed to use the eRez Management Console.

Shared Folders

In order to access images via the eRez Imaging Server you must define one or more shared folders. For security reasons all access to images is via virtual paths based on the name of the shared folder like “share/folder/image.tif”. It is not possible to address images directly using the physical path such as “c:\test\folder\image.tif”.

Access to the images in a shared folder is restricted by means of roles. For instance if you want only users in the marketing department to be able to edit image information, you can create a role named “marketing” and specify that only users assigned the “marketing” role can edit the images. The special roles “?” and “*” means “any known user” or “anybody” respectively. You can also disable the functions completely by selecting “Disabled”. This way nobody – including the administrator – can use the function.

Note: If you plan to feed “Live” images to web pages you must set the view role to “Anybody”.

field

Description

Name

The public name of the shared folder. This is the name that users will see when listing the contents of the server

Path

The local path to the directory with images and sub-directories. This can be a path to a local hard drive or a remote server like "\\HOST\SHARE\EREZ\STUFF" on a Windows System. The sample configuration file that ships with the software uses a special path: "WEB-INF/…”. 

Cache

The directory where derived images are stored for reuse. The same cache directory can be shared by several shares or you can use a separate cache for each.

View Role

The role a user must have in order to view images.

List Role

The role a user must have in order to list the contents of the shared folder. Without this role membership the shared folder will be completely invisible to the user.

Download Role

The role a user must have in order to download images.

Upload Role

The role a user must have in order to upload new images.

Edit Role

The role a user must have in order to edit images and folders.

Delete Role

The role a user must have in order to delete images and folders.

Monitor Files

When this option is enabled (default) eRez will automatically track changes to the files and index files for searching, generate previews etc.

Real-Time Templates

Here you can create and edit the image templates for use with the real-time channel. The real-time channel takes care of rendering low- to mid-resolution images as requested from e.g. a web page.

field

Description

Name

The name of the template.

Hidden

If this checkbox is checked the template will not be included in lists displayed to the users.

Width and Height

The target width and height of the image measured in pixels.  The resulting image will be exactly as large as too fit inside the target box while preserving the aspect ratio (relationship between height and width) of the original image.

Anti Alias Filtering

Enables the anti alias filter to smooth edges and suppress artifacts sometimes caused by downsampling (default).

Preserve Aspect Ratio

Preserves the relative width and height of the source image (default). When this is disabled the dimensions of the resulting image will be exactly as requested.

File Format

The image file format for the generated image such as:

·       JPEG - standard jpeg files following the JFIF standard..

·       Flash" - JPEG compressed Flash movies in SWF format.

·       PNG - 256 color indexed PNG images (better than GIF and with no patent issues).

·       PDF - JPEG or ZIP compressed Adobe PDF files (requires Adobe Acrobat Reader or similar).

·       EPS- Encapsulated Postscript images with embedded 256 color TIFF preview.

·       TIFF- Standard Tagged Image File Format.

Sharpening

The amount of sharpening to apply to the image. Must be in the range -500 (heavy blur) to 500 (strong sharpening). A value of 0 applies no sharpening.

JPEG Quality

The quality of JPEG compressed images. Must be in the range 0 (very poor quality/small image) to 100 (best quality/very large image).

Note: For PDF images a value of "0" means no JPEG compression and ZIP compression will be used instead.

JPEG Chroma Subsampling

Enables downsampling of color information during JPEG compression (default). When this is disabled the file size will increase as much as 30 percent but the color information is preserved at full resolution. Certain computer generated images may appear blurry unless this option is disabled.

Crop

The top, left, bottom and right coordinates of the cropped image. The default values: 0.0, 0.0, 1.0 and 1.0 is the whole image. Example: to remove 10 percent on all 4 sides you would use: 0.1, 0.1, 0.9 and 0.9.

Rotation

The rotation of the image in degrees. Rotation is applied to the image before it is cropped.

Fill Color

The RGB background color used to pad the image in order to fill the template box. Uses standard web color format (e.g. ff0000 is red, 00ff00 is green etc.). When a fill color is specified the resulting image will always have the exact size of width and height.

Overlay

The path and filename of an uncompressed RGB TIFF image with an alpha channel (transparency). This image will be placed centered on top of the resulting image. The transparency of the overlay image is controlled by the alpha channel.

Download Templates

Here you can create and edit the image templates for use with the asynchronous  - or download - channel. The asynchronous channel takes care of rendering images at any resolution for downloading and when new images are uploaded to the server.

field

Description

Name

The name of the template.

Description

A human readable description that can be displayed to the user while choosing from the templates.

Width and Height

The target width and height of the image measured in pixels.  The resulting image will be exactly as large as too fit inside the target box while preserving the aspect ratio (relationship between height and width) of the original image.

Maximum Scale

The maximum enlargement of the source image in percent. The default value is 100. For example to allow the images to be enlarged (interpolated) by 20 percent, use a value of 120.

Overscale Action

This controls the behavior of the image processor when the source image does not contain sufficient data to create the destination image without breaking the “Maximum Scale” barrier. The options  are:

·       Abort Job - This is the default and causes the job to fail.

·       Resize to maximum - The width and height of the destination image is decreased to the honor the maximum scale setting.

·       Ignore - The maximum scale value is simply ignored, allowing the image to be interpolated without limits.

ICC Profile

The description of the ICC profile to use. The eRez Management Console automatically displays a list of installed profiles to use.

The option “no conversion” will bypass the color conversion and keep the image in the color space of the original.

Rendering Intent

The rendering intent determines how eRez handles the ICC color conversion. The rendering intent you choose depends on whether colors are critical in an image and on your preference of what the overall color appearance of an image should be.

You can either leave the rendering intent on "Default" in which case the default rendering intent of the ICC profile is used or choose from the following rendering intents:

  • Perceptual - Aims to preserve the visual relationship between colors so it's perceived as natural to the human eye, even though the color values themselves may change. This intent is suitable for photographic images with lots of out-of-gamut colors.
  • Saturation - Tries to produce vivid colors in an image at the expense of color accuracy. This rendering intent is suitable for business graphics like graphs or charts, where bright saturated colors are more important than the exact relationship between colors (such as in a photographic image).
  • Relative Colorimetric - Compares the extreme highlight of the source color space to that of the destination color space and shifts all colors accordingly. Out-of-gamut colors are shifted to the closest reproducible color in the destination color space. Relative colorimetric preserves more of the original colors in an image than perceptual.
  • Absolute Colorimetric - Leaves colors that fall inside the destination gamut unchanged. Out of gamut colors are clipped. No scaling of colors to destination white point is performed. This intent aims to maintain color accuracy at the expense of preserving relationships between colors and is suitable for proofing to simulate the output of a particular device.

Please note that some ICC profiles produce the same result regardless of the requested rendering intent.

File Format

The image file format for the generated image such as:

·       JPEG - standard jpeg files following the JFIF standard..

·       PDF - JPEG or ZIP compressed Adobe PDF files (requires Adobe Acrobat Reader or similar).

·       EPS- Encapsulated Postscript images with embedded 256 color TIFF preview.

·       TIFF- Standard Tagged Image File Format.

TIFF Compression

The compression scheme used for TIFF files such as:

·       NONE – No compression. Compatible what almost all applications – but the files are large.

·       JPEG – JPEG “Lossy” compression.

·       ZIP- lossless compression.

TIFF Tile Size

A value of “0” uses the standard “stripped” layout for the TIFF file (default). Specifying a tile size will using such as 128, 256 or 512 will create images organized as quadratic tiles which increases performance considerably depending on the size of the source images. This is highly recommended when working with images larger than 50 Mb and a “must” for images with a size of several gigabytes. Note: This format is in compliance with the TIFF specification but some older imaging applications may not be able to read it correctly.

JPEG Quality

The quality of JPEG compressed images. Must be in the range 0 (very poor quality/small image) to 100 (best quality/very large image).

Note: For PDF images a value of "0" means no JPEG compression and ZIP compression will be used instead.

JPEG Chroma Subsampling

Enables downsampling of color information during JPEG compression (default). When this is disabled the file size will increase as much as 30 percent but the color information is preserved at full resolution. Certain computer generated images may appear blurry unless this option is disabled.

Paths

If you check “Render Clipping Path” the current clipping path (if any) will be applied and the background will be filled with white. Requires eRez version 2.5 or later.

Resolution

The resolution of the output image in "dots per inch". A value of 0 means that the dpi is automatically calculated to preserve the width and height (as in centimeters or inches) of the source image.

Sharpening

The amount of sharpening to apply to the image. Must be in the range -500 (heavy blur) to 500 (strong sharpening). A value of 0 applies no sharpening. The "sharpen" filter is best suited for low resolution output. Use "Unsharp Masking” filter instead for high resolution CMYK output.

Unsharp Masking

The Unsharp Masking corrects blurring introduced duringscanning, resampling, or printing.

Amount: The amount of sharpening to apply. The interpretation of "amount" has been designed to mimic the behavior of Adobe Photoshop - but you will have to experiment a little to get the optimum result. As an alternative you may consider using the simple "sharpen" filter for low resolution images.

Radius: The radius of the gauss kernel used to calculate the unsharp value. The interpretation of "radius" has been designed to mimic the behavior of Adobe Photoshop - but you will have to experiment a little to get the optimum result.

Threshold: This attribute is currently ignored and reserved for future use.

 

Installing Packages

This function allows you to upload and install updates and add-ons to the eRez Imaging Server. After uploading the package you will see a list of files to install and in some cases a license agreement. If one or more of the files from the package already exists, the existing file(s) will be backed up in a ZIP file named with the current date and placed in the /WEB-INF/upload directory of the erez3admin servlet.

Licenses, Copyrights and Disclaimers of Bundled Third Party Products


The Apache Software Foundation, Velocity:

The Apache Software License, Version 1.1

Copyright (c) 2000-2001 The Apache Software Foundation. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, must include the following acknowledgement: "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." Alternately, this acknowledgement may appear in the software itself, if and wherever such third-party acknowledgements normally appear.

4. The names "The Jakarta Project", "Velocity", and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact apache@apache.org.

5. Products derived from this software may not be called "Apache", "Velocity" nor may "Apache" appear in their names without prior written permission of the Apache Group.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.


The Apache Software Foundation, Xerces:

The Apache Software License, Version 1.1

Copyright (c) 1999 The Apache Software Foundation. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

3. The end-user documentation included with the redistribution, if any, must include the following acknowledgment: "This product includes software developed by the Apache Software Foundation (http://www.apache.org/)." Alternately, this acknowledgment may appear in the software itself, if and wherever such third-party acknowledgments normally appear.

4. The names "Xerces" and "Apache Software Foundation" must not be used to endorse or promote products derived from this software without prior written permission. For written permission, please contact apache@apache.org.

5. Products derived from this software may not be called "Apache", nor may "Apache" appear in their name, without prior written permission of the Apache Software Foundation.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals on behalf of the Apache Software Foundation and was originally based on software copyright (c) 1999, International Business Machines, Inc., http://www.ibm.com. For more information on the Apache Software Foundation, please see http://www.apache.org/.

Jason Hunter & Brett McLaughlin, JDOM:

 Copyright (C) 2000-2003 Jason Hunter & Brett McLaughlin. All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions, and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions, and the disclaimer that follows these conditions in the documentation and/or other materials   provided with the distribution.

3. The name "JDOM" must not be used to endorse or promote products derived from this software without prior written permission.  For written permission, please contact icense@jdom.org.

4. Products derived from this software may not be called "JDOM", nor may "JDOM" appear in their name, without prior written permission from the JDOM Project Management pm@jdom.org.

In addition, we request (but do not require) that you include in the end-user documentation provided with the redistribution and/or in the software itself an acknowledgement equivalent to the following:

"This product includes software developed by the JDOM Project (http://www.jdom.org/)."

Alternatively, the acknowledgment may be graphical using the logos available at http://www.jdom.org/images/logos.

THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE JDOM AUTHORS OR THE PROJECT CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

This software consists of voluntary contributions made by many individuals on behalf of the JDOM Project and was originally  created by Jason Hunter jhunter@jdom.org and Brett McLaughlin brett@jdom.org.  For more information on the JDOM Project, please see http://www.jdom.org/.