eRez Management Console Help

Version 5.0.x Copyright © 2001-2009 YaWah. An Adobe group company

Table of Contents

 


 

Overview / Introduction


The eRez Management Console allows a user with administrator privileges the right to configure and administrate the eRez Imaging Server from a remote computer on the network by using an internet browser.

Apart from a few infrequently used settings all eRez options can be configured and managed from the eRez Management Console.

The eRez Management Console is implemented as a stand-alone web application and it can easily be disabled by simply removing the [eRez installation path]/webapps/erez/admin/ folder from the server.

Database enabled
eRez now contains an embedded SQL database called Apache Derby, an open source relational database implemented entirely in Java. This database can be substituted by an external SQL database.

For more information on how to connect to a MySQL database please see the YaWah website knowledgebase

Logging in to the Management Console


The first time you start eRez after installation, you can log into the Management console by using the default administrator username and password:
username: admin
password: admin
Naturally the first thing to do is change the administrator password.

Management Console layout


This section describes the general layout of the eRez Management Console.

The management console is divided into four main parts: The title bar, the navigation bar, the list pane and the main content pane.


Title bar
The title bar shows the name of the configuration that is currently been edited. The title is also a link to the configuration management, if the license allows multiple configurations and the user is logged in as main administrator.

If the title bar says eRez this means you are viewing the main configuration. Anything else means you are viewing a custom configuration.

Navigation bar
The navigation bar has a tab like functionality. Selected one of the tabs allows the user to manage shares, users and groups, real-time and download templates, and server settings. The server settings tab is only available in the main eRez configuration.

List Pane
The list pane contains at list of the selected type according to the selected tab, e.g. a list of shares or a list of users etc. In the list is a toolbar where it is possible to add or delete elements.

Content Pane
The main content pane shows the detailed information for the selected element. The content pane contains a toolbar for actions relative to the selected element. The content pane toolbar always contain a help icon with a question mark. Clicking on this icon brings up the online help.

Main eRez configuration and custom sub-configurations


With eRez version 5 a new concept configurations is introduced. Configurations means that you can have special setups (configurations) specified for your customers if you have an ASP license of eRez.

The configuration concept enables the eRez application service provider to sandbox most settings of the eRez Imaging Server to a single customer. Shares, Users, Groups, Real-time and Download templates are now controlled by a configuration.

Running eRez as an ASP allows you as the system administrator to run virtual eRez'es (sub-configurations) totally separate from each other.

Main Configuration
The eRez Imaging Server always contains a main configuration called eRez.
 
This configuration cannot be deleted, and will be the default configuration if no other configuration is specified. The use of configurations is transparent if the eRez Imaging Server is used in a non ASP setup. The management of configurations is only available if the server uses an ASP license. The ASP license also contains the allowed number of configurations, e.g. ASP50 allows 50 configurations and an ASP150 150 configurations etc.
If you are running with an ASP license, you must choose which configuration to use when you logon to eRez:
If you want to access the management module as the eRez system administrator choose "Choose Main Configuration".

You will then see a small eRez displayed at the top:
You will also have access to the menu item Servers which let's you setup your eRez, insert licenses, displays status, access log files etc.

Custom Configurations

In eRez 5 you can have several different configurations - if you have an ASP license.

With the introduction of configurations the customers can now manage their own setup, create shares, users, groups, download and real-time templates. While configurations are self contained, real-time and download templates are handle in a special way.

The templates in the main configuration eRez are considered default templates for other configurations. The templates are visible to the sub configurations and can be used, but not changed. This way the service provider can supply a number of sensible default templates for customers to use, as well as ease the start-up process for the customers.

However, should you choose a sub-configuration like "company" you will see company displayed at the top. And you will not have access to the "Servers" menu item.
Choosing a sub-configuration when logged in as the eRez system administrator, means that you can setup the sub-configuration.

Configurations

Description


Name
Is the name of the configuration.

The main configuration will always be called eRez. If you are editing the eRez configuration you are editing settings for the system as a whole.

If you are editing a custom configuration this will be the name of the custom configuration. The custom configuration name will be the name your client use when calling the eRez use rinterface. eRez is installed with a sample custom configuration called company.

The normal URL for calling the eRez user interface log-in menu from the local machine is:


Calling the eRez the same log-in menu with the company custom configuration, requires that you add &configuration=company to the URL

In both cases the configuration is set on the session, and remains active for as long as the session is active. Notice that you can explicitly state that the eRez default configuration should be used. This might be necessary if you have logged into a sub configuration and need to login into the default eRez configuration afterwards.

When accessing an image with an HTTP request another method is required. To access an image in a sub configuration, the name of the source is prefixed with the configuration. The format for this is two forward slashes followed by the configuration name, followed by a single forward slash, and then the normal image source.

Please see the following examples:

Accessing an image in the default configuration in a share called Samples would look like this:
Accessing an image in the company configuration is a share called Samples would look like this:
Notice that share names are not unique across configuration, as the above example shows.

Viewing or Selecting configurations

Click on Choose Main Configuration to choose the main configuration of eRez. You will see eRez displayed in the center top of the eRez Management Console.

Click on eRez to see and list the subconfigurations.

Click once on the name of the subconfiguration to see the setup.

Double Click on the subconfiguration to select and edit it.


Location
The location must point to an area which is private to the particular custom sub-configuration. Everything created within that sub-configuration: shares, users, FSI preset configurations etc. must have root in the particular physical directory described in the location setting.

For security reasons it is of primary importance that one sub-configuration is isolated from other sub-configurations.

The location must point to some place on the file system where the eRez Imaging Server can access and has the rights to the files.
 
The sample sub configuration "company" that is enabled in eRez's with an ASP license has location:

  • WEB-INF/subconfigurations/company

This means that the company sub configuration will be placed relative to the [eRez installation path]/Tomcat/webapps/erez application on the server, which is below this folder.

Sub-configurations need not have location in a relative path to eRez. Locations can be a direct link to a physical directory on the disk or on another computer to wich the eRez application has access. Examples:

  • c:\eRezClients\subconfigurations\customer1
  • \\10.10.10.10\subconfigurations
  • \\inernal local drive\subconfigurations

Maximum Disc Space Usage

Is the maximum disk space in mega byte the sub configuration can use. Maximum disk space accounts for how much disk space the files uploaded within eRez can use.

Please notice that:

  • If files are added through the filesystem to the shares monitored by eRez, but without being uploaded through eRez, the limit is not enforced.
  • Working copies of files such as shadow TIFF files will take up diskspace. You may therefore experience that the actual physical diskspace exceeds the max diskspace limit.
  • When users upload ZIP files, eRez checks the size of the zip file before deciding to unpack it. After unpacking a ZIP file max diskspace may be exceeded.

Value=0 means no restrictions.


Maximum Number of Files

The maximum number of files that can be uploaded to a configuration. Number of files here is the number of files accessible in the eRez user interface for that sub configuration.

Please notice:

Value=0 means no restrictions.


Maximum Number of Users
The maximum number of users that can be defined for this sub configuration.

Value=0 means no restrictions.

Strategy for managing sub-configurations


If you have an eRez ASP license and you are an eRez administrator, here are a few steps you can go through in order to create and manage sub-configurations.
  1. Create a new configuration. Let's call it "customer"
  2. Define the Name and location for your customer sub-configuration. All things relevant for the "customer" will physically be placed in sub-directories below what you define in location.
     
    A good location could be "WEB-INF/subconfigurations/customer", as this will put all your customer related files into the eRez web file structure under "[eRez installation path]/Tomcat/webapps/erez/WEB-INF/subconfigurations/customer/"
     
  3. Save your sub-configuration, by clicking on
     
  4. Double-Click on your "customer" sub-configuration to select - not just view - the sub-configuration. You will see customer displayed in the title bar.
     
  5. Click on "User" and create a new user called "customeradmin" with administrator priveledges.
    The customeradmin user will only be administrator in the "customer" sub-configuration.
     
  6. Save your customeradmin user by clicking on
     
  7. Click on "Groups" and create a new group called "customeradministrators".
     
  8. Now put your mouse on top of the customeradmin user in the "Unassociated users", hold down your mouse key and drag the customeradmin user to the title "Associated users" and release the mouse key.
    The "customeradmin" user is now a member of the customeradministrators group.
     
  9. Save your customeradministrators group by clicking on
     
  10. Click on "Share" and create a new share named "Customer Images".
    • In the Path field write "images"
    • In the Cache field write "cache"
    eRez will now create the physical directories "images" and "cache" below the "[eRez installation path]/Tomcat/webapps/erez/WEB-INF/subconfigurations/customer/" directory. This means that all files regarding your customer sub-configuration are contained in the directory structure you have assigned your sub-configuration.
     
  11. Now assign the customeradministrator group to the "Customer Images" share. Put your mouse on top of the customeradmininistrators group in the "Unassigned Groups", hold down your mouse key and drag the customeradministrator group to the title "Assigned Groups" and release the mouse key.
    The "customeradministrators" group is associated with the "Customer Images" share and can be assigned individual rights.
     
  12. Save your "Customer Images" share by clicking on
     
  13. Re-edit the "Customer Images" share. You will now see rights boxes below for the Assigned Groups and for Anonymous Rights.
    Give the "customeradministrators" group all rights to the share.
     
  14. Under "Anonymous Rights" set least "View rights" to true by checking the checkbox. With View Rights, users on the Internet will be able to see images from the eRez server on webpages.
     
  15. Save your "Customer Images" share once more.
     
  16. Tell your customeradmin user to log into eRez using the login-url with &configuration=customer. Example:
    • http://erez.mydomain.com/erez/erez?cmd=expand&vtl=frames/i18n/login.html&configuration=customer

     
  17. When your customeradmin user logs into the eRez User Interface he/she will have the option of jumping to the eRez Management Console, by clicking on the "ADMIN" button in the top navigation.
     

Shares


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

Add share. To add a new share either to the main eRez configuration or a sub-configuration

Delete Share. To delete a share, click on the name of the share in the List Pane, and then click on the delete button.

Edit Share. Edit the share settings.

Show Share Statistics. Shows the traffic for the particular share.


Please note: A User must be assigned to a Group and the Group must be assigned to a Share for the user to have rights (other than anonymous rights) to the share.

Edit Share Settings


To edit a share click on .

Click on To commit (save) changes.

Click on To discard (cancel) changes.


Description


Name
The name of the share. This is also the name that will be visible to the users with access to the share in the folder tree of the User Interface.
Please note: You must give the share a name.

Path
The physical path to the share.

For the main configuration:

The physical path can either be relative to eRez, for example WEB-INF/[share name] or a physical path to a directory of which the eRez application has access to.

For a sub configuration:
If you are assigning a relative path or just a name, it will be relative to the root of the sub configuration.

Example: If you assign the share path "financials" to the sub configuration "company" and the location of the company sub configuration is WEB-INF/subconfigurations/company the physical path of the financial share will be:
Please note: You must give assign a physical path to the share.

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

To place the cache within the eRez file structure, choose the relative path: "WEB-INF/cache".

For a sub configuration:
If you are assigning a name, it will be relative to the root of the sub configuration.

Example: If you assign the cache name "cache" to the share "Samples" of the sub configuration "company" and the location of the company sub configuration is WEB-INF/subconfigurations/company the physical path of the Samples cache will be:
Please note: You must assign a cache to the share.

Custom Cache URL
Optional custom URL used to fetch images from the cache. This makes it possible to use an external web server to serve the image files created by eRez.

If you use an Apache or IIS web server to serve images from the cache, you can make the cache available via the web server by assigning the custom cache URL as a virtual directory.

To allow caching in the web server - enable FIFO cache for the share.

FIFO Cache
When this is checked eRez will not set the modification date of a file in the cache when it is referenced and therefore remove the files in the cache on a first-in-first-out basis. This may prevent an external web server from having to update its cache.

Permanent Redirect
When this is checked eRez will use a HTTP code 301 (moved permanently) to redirect to the files in the cache. This may help an external cache system caching dynamic images created by eRez.

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

If you want eRez to automatically create TIFF files from PDF files and extract information from each page such as links, and text that can be searched, you must enable monitor files.

Maximum Disc Space Usage (Mb)
The maximum amount of disc space in megabytes (Mb) that share can use.

Value=0 means no restrictions.

Maximum Number of Files
The maximum number of files the share can contain.

Value=0 means no restrictions.

Please note:

Users can exceed the file quotas and diskspace quotas assigned to them. That is, when a user upload something, eRez checks if the quotas has been exceeded. If not, eRez proceeds processing the upload. The new upload may therefore bring the user above the quotas assigned. Only when users try to upload something the next time, will they be prohibited from doing so.

User rights


When a call is made to the eRez imaging server for a file or a folder, eRez checks if the user has the right to access that file or folder residing within the share. This check is performed for each call.

You can define access rights both for specific groups and for anonymous users. If you have assigned one or more groups to the share, you can check what rights they have. You can also assign rights to anonymous users, which essentially means users not logged in.

View Rights
If checked the particular user group can view images. If you plan to have users view the images of the shared folder on the internet for example in a webpage, view role must be checked.

List Rights
The user must have List Rights in order to list the contents of the shared folder. Without List Rights to the shared folder, the folder and all its contents will be completely invisible to the user.

In the eRez User interface, List Rights gives the user access to see the share all its content such as sub folders etc.

Download Rights
Download rights to the share enables the user to download content from eRez. If the user does not have Download Rights to the share, the download menu in the eRez user interface will be dimmed.

Upload Rights
Upload rights to the share enables the user to upload files to the eRez share. If the user does not have Upload Rights to the share, the upload menu in the eRez user interface will be dimmed.

Edit Rights
Edit rights gives the user access to edit folder information as well as images within the share. However, the user can't edit the name of the top level folder (the share) - this must be done in the eRez management console.

In the eRez user interface, with Edit Rights:

Delete Rights
Gives the user the right to delete images or subfolders within the share

Rights needed to move a file or a folder


To move a file or a folder the user must have: - Edit Right (so the user can get to the move folder or file) - Delete Right (so the user can delete from where they are when moving) - Upload Right (so the user can move to where they want to move to)

Assigned Groups


Each defined user can be assigned to a group, and a group can be assigned to a share. This means that if you are a user belonging to an assigned group, and the group is assigned to the share, you will have the rights checked for assigned groups to the share.

The administrator can remove or add groups to the share by dragging and dropping the group from the list of unassigned groups to the assigned list.

  1. Click on a name of a group in the unassigned list.
  2. Hold down your mouse button while dragging it from the unassigned groups list to the assigned group list
  3. Save your work
  4. Click on the Edit share once more
  5. Now you can check what rights each assigned groups will have to the share

Unassinged Groups


Unassigned Groups is a list of groups not currently assigned with rights to the share.

You can assign groups by:

  1. Click on the name of the unassigned group with your mouse
  2. Hold down your mouse key while dragging it to the Assigned Groups

Anonymous Rights


Check what rights anonymous users will have to the share. An anonymous user is one who is not logged in to eRez. You can consider an anonymous user any user on the internet or any application trying to access eRez without being logged in. If you enable all rights for anonymous users, than anyone can access, view, download, upload, edit and delete your files within the share!

Note:


Show Share Statistics


To show share statistics, click on the statistics button

The Share Monitor will show you the traffic of the share. Click on [Traffic] to see what traffic there has been on the shared folder since midnight.

(Not viewing traffic) (Viewing traffic)

To update the traffic graph click on Traffic once more. The traffic statistics are updated once a minute.

Click on to return to settings.


Users


This is where you define the individual user accounts for the main configuration eRez or client sub configuration. Having a user account means that the user are able to log on to the eRez Imaging Server, and be assigned with the rights associated with that particular user account.

Add user. To add a new user either to the main eRez configuration or a sub-configuration

Delete Share. To delete a user, click on the name of the share in the List Pane, and then click on the delete button.

Edit user. Edit the user's settings.

Show download list. Shows all download for that particular user.


Please note: A user must be assigned to a Group and the Group must be assigned to a Share for the user to have rights (other than anonymous rights) to the share.

Edit User Settings


To edit a user click on .

Click on To commit (save) changes.

Click on To discard (cancel) changes.


Description


Login
The user's "handle" or initials used to log onto the system.

Password
The user's password.

E-mail
The user's e-mail address. Necessary for emailing files within the eRez user interface.

First Name
The user's first name.

Last Name
The user's last name.

Administrator Rights

Enable if the user should have administrator rights.

For the main configuration:
Being an administator means that the user can edit all parts of the system. An administrator for the whole eRez configuration can also setup custom sub configurations, if the system has an ASP license.

For a sub configuration:
Being an administrator for a sub configuration, means that the user can setup shares, users, groups, real-time and download templates for that sub configuration.

An administrator for a sub configuration will not have the priviledge to edit Server settings.


User Downloads


Total number of downloads

The total number of files downloaded by the user.

Please notice that number of files is number of files generated for download not actual downloads.


Total size of downloads (Mb)
The total size in megabytes (Mb) of the users uploads.

Total time processing downloads
The total processing time eRez has spend processing files for download. The format is hours.minutes.seconds.

Associated groups


Lists the groups the specific user is associated with.

To edit the groups the user belongs to, you must associate or disassociate the user by clicking on Groups in the Navigation bar.

Show Download List


The user Downloads provides an overview of what files has been downloaded by the user. The assets are the files downloaded.

To refresh the User Downloads overview and show an updated list of click on

To return to User Settings click on


Groups


Groups are simple names used to assign privileges to individual users.

In order to access images via the eRez Imaging Server you must define one or more shares. For instance you can create a group named "resellers" and for a share specify that only users belonging to the "resellers" group can download images from that specific share. This way only users belonging to the "resellers" group (and administrators) can download files from the share and its subfolders.

Add Group. To add a new group either to the main eRez configuration or a sub-configuration

Delete Group. To delete a group, click on the name of the group in the List Pane, and then click on the delete button.

Edit Group. Edit the group settings and associate users with that group.

Edit Group Settings


To edit a group click on .

Click on To commit (save) changes.

Click on To discard (cancel) changes.


Description


Name
Is the name of the group. The group name will link the users to their rights to shares.

Edit FSI Templates Allowed

Enables users with this group to edit FSI Templates in the eRez user interface. Instead of having to save the generated html code in the Publish to Web of the user interface, users belonging to a group with edit FSI Template rights can save their own FSI preset configurations to the eRez server.


Associated users


Lists the users within the main eRez or custom sub configurations associated with this group.

To delete an associated user click on the username and drag it to the Unassociated users bar.

Unassociated users


Lists the users within the main eRez or custom sub configurations currently unassociated with this group, but who can be associated.

To add an unassociated user to the group click on the username and drag it to the Associated users bar.

Realtime 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.

It is the real-time templates that are used by the "Publish to Web" menus and functions in the eRez user interface.

Add Real-time Template. To add a new Real-time Template either to the main eRez configuration or a sub-configuration

Delete Real-time Template. To delete a Real-time Template, click on the name of the Realtime Template in the List Pane, then click on the delete button.

Edit Real-time Template. Edit the Realtime Template settings.

For the main configuration:
The real-time templates configured here are available to all configurations, including custom sub-configurations.

For a sub configuration:
Real-time templates defined for a sub-configuration is only available to the FSI preset configurations and eRez templates using that sub-configuration.


eRez real-templates

Here is a little overview of some of the main eRez configuration real-time templates:


Edit Real-time Template


To edit a realtime template click on .

Click on To commit (save) changes.

Click on To discard (cancel) changes.


Description


Name
The name of the template.

Invisible
If enabled the template will not be included in lists displayed to the users of available real-time templates in the eRez user interface.

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

Width (pixels)
The target width 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.

Height (pixels)
The target 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.

Behaviour


Eyecon Position
“Eyecon” image (hotspot) position. Legal values are:
0) None
1) Upper-left
2) Upper-right
3) Lower-left
4) Lower-right

Overlay X Position
Position of the left edge of the overlay image in the range (0.0 – 1.0).

Overlay Y Position
Position of the top edge of the overlay image in the range (0.0 – 1.0).

Auto Crop

If Disabled eRez will resize the image to fit width and height of the image

If Enabled eRez will automatically crop the image as necessary to fit the specified width and height. The default auto cropping anchor is 1 meaning cropping from from all sides towards the middle center of the image.


Auto Crop Anchor

If Auto Crop is enabled eRez will crop the image towards the anchor point to fit the target width and height.

Legal values are:

1) middle center (default)
2) upper left
3) upper center
4) upper right
5) middle left
6) middle right
7) lower left
8) lower center
9) lower right

Keep Aspect Ratio

Enabled preserves the relative width and height of the source image (default).

Disabling the Keep Aspect Ratio will force the eRez server to return an image with exactly the specified width and height and ignore the aspect ratio of the source image. When this is disabled the dimensions of the resulting image will be exactly as requested.


Zoom Level

Set to 0 to not zoom at all.

To have eRez automatically crop the image to match the desired zoom level.

Possible values: 1 - 100, where value=100 is zoomed in to the max of the original image (100% zoom level).


SVG Scale Factor
Scale hint to help eRez pick the right resolution. The value is calculated by the eRez server.

Brigtness
Brightness adjustment. Possible values are 0.0 to infinite.

File Mode
Controls the way images are padded. Possible values are:
0) Horizontal and vertical padding.
1) Horizontal padding only.
2) Vertical padding only.

Image Format


Crop Top, Left, Bottom, Right

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
,
0.9

Shapen
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.

Format

The image file format for the generated image such as:


Quality (0-100)
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. 

No Chroma Samplint
Enables down sampling 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.

Antialias
Enables the anti-alias filter to smooth edges and suppress artifacts sometimes caused by down sampling (default).

Use Black Point Compensation

Black Point Compensation (BPC) is a technique used in digital photography printing. It ensures that the shadow detail in the image is preserved by simulating the full dynamic range of the output device - essentially making black more black. BPC can be used when transforming files using ICC profiles form CMYK to RGB.

As black is not always totally black in CMYK, it will be mapped to something not completely black in RGB, essentially making the RGB image more "grey". Using BPC is enabled by default.


Borders


Border Color
Is an optional RGB border color and will append a border of that color around the image.

The default border color is -1 meaning no border color.

Border Top
Top border size in pixels. The maximum allowed size is 100 pixels.

Border Left
Left border size in pixels. The maximum allowed size is 100 pixels.

Border Bottom
Bottom border size in pixels. The maximum allowed size is 100 pixels.

Border Right
Right border size in pixels. The maximum allowed size is 100 pixels.

Paths


Fill Color (RRGGBB)
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.

Watermark Path
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.

Alternative Image

Alternative URL encoded eRez path to the image to use if the source image does not exist. The alternative image may be an image saying "Not found", "Photo on its way" or the like.

You can customize the Alternative image with your own artwork and graphical identity.


SVG Parameters


Use SVG Template
If enabled, renders the SVG Template defined in SVG Template Name (file)  with the image.

SVG Template Name (file)
SVG template name specifies the file name of the SVG template to use.

The real time template most have template name override enabled, otherwise the parameter is ignored.

Allow SVG Template Name Override
Allow the SVG template name to be overridden by command. If this option is enabled, the SVG template name can to be overridden by the request for an image

By default this is false for security reasons.

SVG Anchor
Specifies where the SVG overlay is anchored. Values are one of the four corners and centered:
lt) left top
rt) right top
lb) left bottom
rb) right bottom
c) center

SVG Scale
Specifies how the SVG template scales. Use either fixed size or size as relative to the requested image.

The possible values specify how to interpret the size of the SVG template. Values:

SVG Scale Value

Specifies the scale value for the SVG template.


SVG Parameters
The list of parameters that can be substituted at runtime.

The parameters must be separated by inserting a |. When parameters for the SVG template are defined they are passed onto the template at runtime. If the parameters are used within the SVG template they can use the values specified.
Example: font=Arial|font-size=12pt|color=#000000
The font, font-size and color parameters are assigned default values here. If the parameters are not assigned a value at runtime, these default values are used.
Please see eRez SVG templates Guideline for more information.

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.

It is the download templates that are used by the "Download" menu in the eRez user interface.

Click on the Download template name in the List Pane to view.

Add Download Template. To add a new Download Template either to the main eRez configuration or a sub-configuration

Delete Download Template. To delete a Download Template, click on the name of the Download Template in the List Pane, and then click on the delete button.

Edit Download Template. Click on the Download template name in the List Pane to edit.

For the main configuration:
The Download templates configured here are available to all configurations, including custom sub-configurations.

For a sub configuration:
Download templates defined for a sub-configuration is only available to the FSI preset configurations and eRez templates using that sub-configuration.


Edit Download Template Settings


To edit a Download template click on .

Click on To commit (save) changes.

Click on To discard (cancel) changes.


Description


Name
The name of the Download template.

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

Width (pixels)
The target width of the image measured in pixels.

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

Height (pixels)
The target height of the image measured in pixels.

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

Behaviour


Maximum Scaling
The maximum enlargement of the source image in percent. The default value is 100.

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 Scaling" barrier.

The options  are:


Use Black Point Compensation
Black Point Compensation (BPC) is a technique used in digital photography printing. It ensures that the shadow detail in the image is preserved by simulating the full dynamic range of the output device - essentially making black more black. BPC can be used when transforming files using ICC profiles form CMYK to RGB.

As black is not always totally black in CMYK, it will be mapped to something not completely black in RGB, essentially making the RGB image more "grey".

Use BPC is enabled by default.

Image Format


Format
The image file format for the generated image such as:

More formats can be implemented by means of Plug-Ins.

Profile Name
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:

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


Compression
The compression scheme used for TIFF files such as:

Quality (0-100)

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.


Resolution
The resolution of the output image in DPI (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.

Shapen

The amount of sharpening to apply to the image.

Please note:


No Chroma Samplint

JPEG Chroma Subsampling: Enables down sampling of color information during JPEG compression (default).

Note:

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.


Render Clippath
If you check "Render Clipping Path" the current clipping path (if any) will be applied and the background will be filled with white.

Crop Top, Left, Bottom, Right

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
,
0.9

 


Tile Size
A value of "0" uses the standard "stripped" layout for the TIFF file (default).

Specifying a tile size while using such values as 128, 256 or 512 will create images organized as quadratic tiles which increase 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.

Unsharp Mask


The Unsharp Masking corrects blurring introduced during scanning, resampling, or printing.

Unsharp 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.

Unsharp 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.

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

Servers


The server settings tab is only available in the main eRez configuration.

Edit Server settings.

 Server Statistics, shows the eRez Performance Monitor, period statistics and overview statistics.

 Server status, shows the status of eRez, Real-time and download imaging engines, queue sizes, Java, operating system, and machine specifications, as well as activity status.

 Server Messages, shows server message e-mails sent by the server to the administrator and users.

 Server licenses, viewing and editing licenses - eRez and FSI.

 Server logs, shows system log files.

 Install package.


Edit Server Settings


Click on the name of the server - in most cases eRez Imaging Server to see Server Settings.

To edit Server Settings click on .

Click on To commit (save) changes.

Click on To discard (cancel) changes.


URLs


Public URL

The public URL of the eRez sever such as "http://erez.yawah.com/erez".

This URL is used when creating emails, building HTML page with the URL Builder and generate code for the FSI Viewer, Showcase and Pages.


Proxy URL

By nature this is a very advanced feature designed to be used with caching reverse proxy servers and CDNs (Content Delivery Networks).

The proxy URL is the URL to the CDN proxy for instance:

  • http://akamai.mycompany.com/erez
  • http://mirrorimage.mycompany.com/erez
  • http://edgecast.mycompany.com/erez

Proxy URL Type

The Proxy URL Type is the name of the CDN provider such as:

  • akamai
  • mirrorimage
  • edgecast

System Behaviour


Number of Real-Time Imaging Threads

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

In a standard eRez scenario, a rule of thumb calculation says:

Number of Real-Time Imaging Threads = Number of "Available CPUs" + 1


Number of Download Imaging Threads

The maximum number of concurrent image processing operations for high resolution images. The default value is 2. 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.

In a standard eRez scenario, a rule of thumb calculation says:

Number of Download Imaging Threads = (Available memory / 128 Mb) – Number of Real-Time Imaging Threads

and

Number of Download Imaging Threads <= (Number of Real-Time Imaging Threads / 2 )


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.

The size of the uncompressed image is not size on the disk - it's is size in the memory, this means that the eRez system can be slowed down tremendously using uncompressed images, sometimes 100 to 1000 times slower!
 
To calculate the size of an RGB image in memory:

Width of the image x height of the image x red x green x blue

This means if the image is 1000 pixels by 800 pixels the calculation is 1000x800x3 = 2400000

 To calculate the size of a CMYK image in memory:

Width of the image x height of the image x 4

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.

The default value is 500 Mb.

Note:

What is a busy server?


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.

Automatically configure threads
Automatically configuring of threads means that eRez by itself calculates a suitable number of real-time and download imaging threads.

The number of each type of threads is calculated on the basis of how much memory is available for eRez and how many CPU's the machine has and how many CPU's is utilized as per your eRez license.

The default automatically configuring is enabled.

Synchronize Color Management

Implemented a workaround for a problem found with several implementations of the Java Virtual Machines from Sun, IBM, Apple and possibly others. Apparently some of the low level Color Management functions are not fully reentrant and may cause the JVM to crash on some (but not all) multi CPU systems.

Unfortunately this extra synchronization may limit the performance on systems with more than 2 CPUs. So our recommendation is to not enable this workaround unless your server is affected by this problem.

Things that might indicate that your server is affected by this problem are if in your log file you see:


File System


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 "erez" 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 "erez" directory.

Hot Folder Pause Length (Sec.)
The number of seconds to wait between each scan for changes to the shared folders.

The default value is 5 minutes is (300 seconds).

Lay Time (Sec.)
The number of seconds to wait before handling a new file after the last time the file was modified.

The default value is 30 seconds.

HTML Encoding
Character encoding used for HTML output.

IPTC Encoding
Character encoding used when writing IPTC data. Default is ISO-8859-15

Assumed IPTC Encoding
Assumed character encoding for IPTC data with no encoding information.

In some cases eRez does not know what character set is used, by setting Assumed IPTC encoding to UTF-8 inserts IPTC information correctly.

Enable Native SVG Support
Turn native SVG support on or off.

Use External IPTC Files

External IPTC means that users can add IPTC data, such as keywords, to video clips and other files not normally supporting IPTC data. With TIFF and JPEG files such IPTC data is written inside the file.

  • By enabling eRez ceates a "sice-car" file with the infomation to each file.
  • If disabled your users can't save IPTC information on file formats not supporting IPTC data such as videos.

Next backup time

eRez automatically create backup of the Derby database.The next time for backup is the value in the "Next backup time" parameter, which means that you can change this time manually.

The root backup directory is [eRez installation directory]tomcat/webapps/erez/WEB-INF/private/index/

Please notice:

  • This backup option is only possible if you use the internal Derby database.
  • Each backup created is a consistent backup where integrety is maintained
  • Backups is only made to your local disk - it is your responsiblity to save it to an external backup media.
  • Backups are rolling. Only the last 7 backups will be kept on your local disk.

Restoring a backup

To restore a backup just copy the backup one level up. Example:
If you have a backup folder called "backup 2009.01.01.10.45.14.896" copy the contents from it's subfolder "eRez" to the [eRez installation directory]tomcat/webapps/erez/WEB-INF/private/index/eRez/ folder.


Hours between backups

Sets the number of hours between backups.

  • The value of the "Next Backup Time" is increased by the number of hours set here.
  • You can change the value to change the frequency of backups.

Use shadow pyramid TIFF files for flat fileformats

Shadow TIFF files are pyramid TIFF files created for each uploaded JPEG or image file. Prior to eRez 5 downloading "original file" meant downloading a pyramid TIFF version of the uploaded JPEG file.

By setting "Use shadow TIFF" eRez 5 will now save the orginal uploaded JPEG file and create a pyramid TIFF for fast zooming, rendering etc.

Shadow pyramid TIFF files are placed in a sub-folder ".erez" below the shared folder of the orginal file.

Note:

  • When eRez converts a file to pyrmid TIFF the size of the the pyramid TIFF will on average be 130% of the orginal
  • Using shadow TIFFs means that diskspace for each upload file will increase diskspace needed:
     
    + 100% of the orginal image file
    + 130% for the shadow TIFF file
    = Each uploaded file will need 230% of diskspace for each upload

E-mail


E-mail disabled
In order for the eRez server to send emails this value must be false. By default this is true when the server is first installed, which means that the eRez Imaging Server does not send out emails.

SMTP server
The hostname or IP address of the outgoing SMTP server.

SMTP user name
Optional user name required to connect to the SMTP server.

SMTP Password
Optional password required to connect to the 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.

Server Statistics

Show Live Statistics


Performance Monitor

With the eRez Performance monitor you can monitor the health of your server right now.
The values are sampled in real-time but the sample size interval is one minute. The statistics file is updated at every five minute, e.g. 00.05.00, 00.10.00 etc.

The performance monitor lets you monitor:

Click either on the "Show All" menu for the total views, or on individual monitors.


Hits - Requests by Type


Click on one of the following request types to view or hide it in the graph:
  • Hits
    The total number of request the server received within a sample interval.

  • Cache Hits
    The total number of request that was served from the cache within the sample interval.

  • Real-Time Request
    The total number of real-time request within a sample interval. Real-time requests are the time critical part of eRez. The ability to serve real-time requests is essential to the perceived performance of the server. Notice that a request for an image that is in the cache does not require a real-time request. Real-time request are when the server needs to create an image.

  • Max Concurrent Hits
    The maximum number of concurrent hits within the sample interval. This is a good performance indicator as it describes how much work the server has to do at the same time. If the Max Concurrent Hits grows or is at a constantly high level, it could be an indication that the server cannot handle the load.

  • RAM Cache Hits
    Hits to the RAM cache, which are served faster than hits to a cache on the disk.

    RAM cache is automatically created and setup by eRez - you don't have to do anything to use the RAM cache. To increase RAM cache you should setup eRez for more memory.

    If an image variant is not in the RAM cache, eRez then looks in the disk cache. IF it does not exist there it is produced by eRez and placed both in the RAM and disk cache.

    After eRez restart the RAM cache is not populated immediately, and you will see more hits to the disk cache than the RAM cache. Over time you will see how hits to the RAM cache increases.

Memory


Click on one of the following request types to view or hide it in the graph:
  • Total Memory
    The total amount of memory in the Java virtual machine measured in kilobytes.
    The value may vary over time, depending on the host environment.

  • Free Memory
    The amount of free memory in the Java Virtual Machine as an approximation to the total amount of memory currently available for future allocated objects, measured in kilobytes.

  • RAM Cache Memory Available
    How much RAM is available for the RAM cache in total.

  • RAM Cache Memory Used
    How much memory is used by the RAM cache. As eRez has been up and running for some time you will see hwo the RAM Cache Memory Used increases.

Response - Response Times in Miliseconds


Click on one of the following request types to view or hide it in the graph:
  • [- :250]
    The total number of request processed in less than 250 milliseconds within the sample interval. This gives an indication on how the user perceives performance. In itself the responds times does not indicate if there is a performance problem. The responds time for a large image is greater that for a small image, so a single request can take a long time not because there are lot of jobs running, but the because the request requires a long processing time.

    There are two things one can do to enhance performance.

    • If a request requires a long processing time, the solution is to use faster processors.
    • If the responds time is high because the load is high, there are more factors in play. The solution could be faster processors, more processor, more RAM, faster disks, or load balancing.

  • [250:500]
    The total number of request that took between 250 and 500 milliseconds to process within the sample interval.

  • [500:1000]
    The total number of request that took between 500 and 1000 milliseconds to process within the sample interval.

  • [1000:2000]
    The total number of request that took between 1 and 2 seconds to process within the sample interval.

  • [2000:4000]
    The total number of request that took between 2 and 4 seconds to process within the sample interval.

  • [4000:-]
    The total number of request that took over 4 seconds to process within the sample interval.

Queues - Queue sizes


Click on one of the following queue sizes to view or hide it in the graph:

Show Period Statistics


Performance Statistics over a period of time

With the eRez Performance Statistics you can lookup performance statistics for a period of time.

Please see Show Live Statistics for a description of Performance statistics.

Default the link displays today's statistics file from 00.00 to 23.59.59, with Hits as the only selected sample.

Period statistics are chosen by selecting a from date+time and a to date+time in the format:

From 
  2008-10-01 00:00:00
       To  
  2008-20-31 23:59:00


The date-time format is yyyy-mm-dd hh:mm:ss  (Year-month-day hours:minutes:seconds)

After inserting the date click on "Refresh Statistics" to update the graphs.


The performance statistics are the same as shown with live statistics.

For an explanation please see:


Show Overview Statistics


Overview Statistics

Overview Statistics gives you an overall indication in pie charts of the distribution of hits and response times in a particular period. This will tell you something about the load on your server.


Hit Type


When a user request hits the eRez server, it’s a hit – even when it is not an image!

Shows the distribution of

  1. The cache is too small.
    This means that image variants need to be created by eRez all the time, as they do not live long in the cache.
     
  2. You are running a system, where users zoom into new areas of the images all the time.
    Perhaps you have a lot of online eCataloges where the FSI Pages is set to resize. This would mean  that new sizes of the catalog pages are requested all the time, requiring many new real-time requests.

Response Times


Response Times are the time from a request enters the system until it is served. But please note - this is not the same as the  actual time it takes it to be transferred from eRez to the Internet

The Response time's pie chart shows the distribution of response times in milliseconds.

Generally speaking 80% of your response times should be between 0 - 250 milliseconds and less and less should be longer.

Response Times
0 - 250 miliseconds 80%
|
V
|
|
|
|
|
|
|
|
V
 
250 - 500 milisecons
500 miliseconds - 1 second
1 - 2 seconds   You
have a
busy server
2 - 4 seconds
> 4 seconds




Show Server Status


Server Status gives you information about the state of your eRez imaging Server. The information concerns some statistics as well as information about the machine you are running on and your eRez license. If you have watermarks in your images, a good place to start is here, comparing what your license allows you to do and what is actually going on.

If you have problems and needs help from YaWah Support (support@yawah.com) please go to the Server Status page, copy the information and paste it into the email you send to YaWah Support.

The activity reported in Server Status is activity since eRez was last started.


eRez


Information about your eRez imaging server.


Realtime Imaging Engine


The Real-time Imaging Engine takes care of rendering low- to mid-resolution images as requested from e.g. a web page.


Download Imaging Engine


The Download Engine is an asynchronous channel taking care of rendering images at any resolution for downloading and when new images are uploaded to the server.


Queue Sizes


Internal eRez queues. If eRez seems very slow large queues may indicate where the bottleneck is.
  • Realtime Queue Sizee. How many images are waiting to be served to the web.
     
  • Download Queue Size. How many jobs are in the download queue waiting to be processed.
     
  • Upload Queue Size. How many uploaded files are waiting to be unzipped and/or rendered to pyramid TIFF right now.
     
  • Preview Queue Size. Used for making previews for files such as PDFs.

Java


Is information about your Java environment, application server, operating system, memory etc. that the Java virtual machine can extract. It is also what is available of system resources to Java.
  • Total Images. The total number of images in your system. If you have a license with restrictions on the number of images in your eRez (eRez Basic, eRez Standard, ASP-50 licenses), total images gives you an indication on how close you are to the limit.
     
  • Operating System. The operating system type and version.
     
  • Java Environment. The version and type of Java installed on the machine
     
  • Java Server. What Java Application Server is used for deploying the eRez web application.
     
  • Total Memory. Total memory available for eRez. This is set by the -Xmx parameter in the environment properties.
     
  • Free Memory. How much of total memory is currently not used.
     
  • Available CPUs. How many CPUs are reported by the operating system.
     
  • JAI Version. What Java Advanced Imaging version is used. (JAI is a Java platform extension API)
     
  • Date & Time reported by the system.
     

Activity


Activity reports the state of the various threads and engines in eRez.

This activity overview is usefull if you think eRez is running slowly. eRez may be "slow" because it is doing a lot of work such as real-time and download rendering. Is the state of real-time and download threads "RUNNING" this means that eRez has a lot to do!

No Licenses Installed


The eRez system is running unlicensed!

To Activate
To Activate, please go to:
  1. Show Server Licenses
  2. Activate eRez PID
  3. Activate your eRez (Activate YaWah.com Software Product)
  4. The license will be sent to you in an activation e-mail.

Enter the eRez license

To Enter the eRez license (the license is sent to you with your activation email), please go to

  1. Show Server Licenses
  2. Enter eRez/FSI license
  3. Paste the license from your activation email into the eRez License key field
  4. Click on Commit Changes to save your license key.

License for


License for [licensee] where licensee is the name of the company who owns the license, and for whom it is registered for.

  • License State.  Is it a valid license or not?
     
  • hostip.  What host IP number was the license activated for.
     
  • asp.  If it is an ASP license, how many clients' sub-configurations does the license allow.
     
  • maxcpus.  How many CPUs does the license allow eRez to utilize.
     
  • soap. Is 1 if the license contains using the SOAP development KIT with eRez.
     
  • cadview. Is 1 if the license contains a CADview license enabling you to use the CAD files view plug-in.
     
  • erez version.  What version of eRez is the license registered for.
     
  • hostname.  What host name was the license activated for.
     
  • stopdate.  Does the license have an end date? If yes, then the license will stop working after that date.
     
  • startdate. What is the start date of the license? This is the day the license was activated.
     
  • licensee.  The name of the company for whom the license was registered.
     
  • cdn. Is 1 if the license allows use of a CDN (Content Delivery Network) connector (Proxy URL)

Show Server Messages


Server messages are emails sent or could have been sent from the eRez system, if the eRez e-mail sending property was setup  correctly.

To setup email sending:

  1. Click on Servers in the Navigation bar
  2. Click on Edit Server Settings
  3. Enable E-mail and set it up correctly

Server Messages are shown by choosing a From date and perhaps a To date:

From 
  2008-10-01 23:59:00
       To  
  2008-10-31 23:59:00
   and click on  to refresh the Server Messages list.

The date-time format is yyyy-mm-dd hh:mm:ss  (Year-month-day hours:minutes:seconds)


Message
Click on a message line and see the message (what was sent) displayed in the Message part of the screen.

S is the status of the message

+ means that it has been sent

- means that it has not been sent


Date
Date and time when the message was sent or attempted sent

To
The recipient of the message

From

The sender of the message who can be:


Subject

Subject of the message.

If you see something like eRez 5.0 - Build 9999 (20081001) in the subject, it is a message sent each time the eRez system is restarted.


Show Server Licenses

Server licenses are eRez and FSI Viewer licenses installed on the server. You are able to run both the eRez Imaging Server as well as the FSI products without a license. However, running without a license means that you will see logo watermarks inside your images.

YaWah eRez licenses

Without an eRez license from YaWah, watermarks will permanently be rendered inside images when you upload images to eRez.

Without a valid license watermarks will be rendered on top of images too.

Other license options from YaWah:


Neptune Labs FSI licenses

Without an FSI license from Neptune Labs, watermarks will be rendered on the images of your FSI Viewer.

Other FSI license options from Neptune Labs:

The above mentioned extra license options are part of the FSI License. If your FSI license does not contain one or more of the options you will see watermarks inside your images.


No Licenses Installed

If you see this message, no eRez license is installed on your server.


No FSI License found

If you see this message, no FSI license is installed on your server.


License for


License for

License for [licensee] where licensee is the name of the company who owns the license, and for whom it is registered for.

  • License State.  Is it a valid license or not?
     
  • hostip.  What host IP number was the license activated for.
     
  • asp.  If it is an ASP license, how many clients' sub-configurations does the license allow.
     
  • maxcpus.  How many CPUs does the license allow eRez to utilize.
     
  • soap. Is 1 if the license contains using the SOAP development KIT with eRez.
     
  • cadview. Is 1 if the license contains a CADview license enabling you to use the CAD files view plug-in.
     
  • erez version.  What version of eRez is the license registered for.
     
  • hostname.  What host name was the license activated for.
     
  • stopdate.  Does the license have an end date? If yes, then the license will stop working after that date.
     
  • startdate. What is the start date of the license? This is the day the license was activated.
     
  • licensee.  The name of the company for whom the license was registered.
     
  • cdn. Is 1 if the license allows use of a CDN (Content Delivery Network) connector (Proxy URL)
Note: The host name and/or host IP but match what the URL you use to call eRez with. If not please notify your reseller if you have not activated your eRez PID for the correct host name and/or IP number, so they can request a re-opening of your eRez PID for re-activation.

Original License Key

Is the content of your licence key.

Click on to remove the license from your system

Typically the license will look like something like this:

oCBNCNQT2nlfl8pPE/j5Sap7SXfCJLQ41iNAq+3vGrWjeluBvYPitQ
cWy8dG+LraRLNH3lTK8+zgyCRubkXBstCyWOqlnmo+5Y2ReSEN
G9muZpm3ho/OpzZj/TMAAoSHginyjcD/RmsVNO/o8FzA29a688RxcxioHUEYyvlUv7v+uY++lmKGFHIQ2va6XA3TigxZ56
grLNaNJIvPtniK+j2WR/dP8BKPedCIDuMCbJUGPxHufo0CA

FSI License Key


Domains
Domains are the domains or IP number the license is registered for.

Note: Check that the FSI domain or IP match the host name or host IP for eRez. If not please notify your reseller if you have not activated your FSI PID for the correct domain or IP number, so they can request a new FSI PID for you.

Original FSI License Key

Is the content of your FSI licence key.

Click on to remove the license from your system

Typically the license will look like something like this:

dO9nxEO9xr49mTr2.Cxg29bdSsgTm2Cxrsx.TxdCgaOr2s.999CJmEr
EKXd92rr92gmET.xJx9mCJ9arxCXX9TarraEdggXCmTgCmOJOXaOx2X
OYhTCCaXdEgs.OTsr2rxrmEgmbm.8dOXJmrTdJsx9rr92gxxxm/aEgxTXrar
aOsrg.g2XaXrd.O.rr2CrCgJdCdaTJXpJTm9Ea.T3dOO9XTT5CO.xm9X
rEga.r92ExxJooTJ.XgOJ9Ts2d2OgJJJxmO9OaxxsE9aCd9OxdaxgmEOa2
rmT.Osrg9mOOm2xxXs9s.9CXxX.aaaXC.929TXX22CCX.g9gTdJgCOJ2TCx.CdxJOOrxaC2ga2COdd.9OOr...sTJmECxam29rCX.OmdT.aOgxa2.TTsaCgsTgdrEJTCaCsmErXCErr.TsxaggT.Eg.xOssJgJ.aOEsddd9ra.rgrEa2rsrgXXO.JdrTd9TEJxTJEmaE9OJTmsJCXTaTC.CTdsgJO.E2dxaJdrDma9JrOTsOd9rJETC2OJ.OrC92ExXddxX9TxJTJ.xdXXJJJmr2E9gEggx.Tg9OgxaX.gCgrEs2ggmTsOEgOdO9sgr29XCTQVa9mrTOEcd.9.E.9X2x2O9.9.CgT2rarg2OdOn9dX

Enter eRez/FSI License



License Key
When you register eRez you receive an activation email with your license key. Paste the license key into the key field and click on to activate your license.

To see the state of your license Click on:

  1. Servers
  2. The "Server name" in the List Pane
  3. License Overview

After activation it is always a good idea to:

  1. Restart your eRez Imaging Server
     
  2. Clear the cache of your internet browser

FSI License Key
When you activate FSI you receive an activation email from Neptune Labs with your activation license. Paste the license into the FSI Licence Key field and click on to activate your license.

After activation of your FSI license, it is always a good idea to:

  1. Clear the cache of your internet browser

Activate eRez PID


Click on to activate your eRez PID.

Here is some very important advice:

  1. eRez can be registered both for a host name and a host IP (that is IP number).
     
  2. If you plan to access eRez with a host name, you must register eRez for a hostname (example: erez.mycompany.com) a domain name is not enough!

    In this case you must register FSI for a domain name - for example (mycompany.com)
     
  3. If you plan to access eRez with an IP number, you must also activate FSI for the IP number - don't use a domain name!
     
  4. All the URL's created with eRez will use the Public URL and the Public URL must match the host name or IP number registered for eRez.
     
  5. The activation email can be sent to more than one e-mail account if you separate email addresses with a comma.

Activate FSI PID


Click on to activate your FSI PID.

Here is some very important advice:

  1. You must register FSI  either for a domain name or an IP number
     
  2. IF you register FSI for a domain name the domain name must be part of the URL you will use to access eRez with.

    Example:
    • FSI registered domain name = mycompany.com
    • eRez has been registered for host name = erez.mycompany.com
    • The Public URL should then be: http://erez.mycompany.com/erez ,
      or if you use a port such as 8080 http://erez.mycompany.com:8080/erez
  3. IF you register FSI for an IP number the IP number must be part of the URL you will use to access eRez with.
     
    Example:

    • FSI registered IP number = 127.0.0.1
    • eRez has been registered for host name = 127.0.0.1
    • The Public URL should then be: http://127.0.0.1/erez ,
      or if you use a port such as 8080 http://127.0.0.1:8080/erez

Show Server Logs


Select log file

Select the log file to view in the drop down list.


Go to page
Input box for going to a specific page in the currently shown log file. Click on to refresh after you have changed the page.

Action buttons

Reload log file page

Go to First page

Go to Previous page

Go to Next page

Go to Last page


Install Package


Install Package

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.


Upload Package
After specifying the zip package to upload click on Upload Package.

Files to install
Lists the files inside the package relevant for installing on the eRez 5 server. If no relevant files are found Install Package will tell you so.

Accept license and install package
Click on the "Accept license and install package" if you accept the license inside the package and wish to install.
 
Click on the Cancel button if you do not accept!

Backup of installed package files

 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 [eRez installation directory]/tomcat]/webapps/erez/WEB-INF/upload directory.

The backup zip file will be named backupYYYY_MM_DD_HH_MM_SS.zip where YYYY_MM_DD_HH_MM_SS is Year_Month_Day_Hour_Minute_Second.


Upgrading your eRez 5.x installation

Please the the YaWah website Knowledgebase for information about how to upgrade existing eRez 5.x installation.


Upgrading an eRez Imaging Server version 4.x to version 5.x.


Please the the Technical Note 011125 on the YaWah website for information about how to upgrade an existing eRez version 4.x to eRez version 5.x.