eRez Imaging Server 4.1

HTTP Command Reference

18-sep-2007

 

Copyright 2001-2007 YaWah.com. All Rights Reserved

 


Introduction

 

This document contains a complete, highly technical description of all the commands that can be sent to the eRez Imaging Server 4 using standard HTTP get and post methods. The SOAP interface add-on product is not covered by this document.


 

Table of contents

 

Introduction. 2

Table of contents. 3

Overview. 4

The Velocity Template Engine. 6

The eRez Imaging Server Architecture. 7

Permissions. 8

Log file entries. 9

User Parameter 10

Session Parameter (since 4.1) 10

Overriding HTTP Headers (since 4.1) 10

Activate Command. 11

Cancel Command (deprecated) 11

Confirmdel Command. 12

Confirmdelselection Command (since version 4.0) 13

Del Command. 14

Delselection Command (since version 4.0) 15

Download-prepare Command (since 3.0) 16

Download-submit Command (since 3.0) 17

Downloading Data (since 3.0) 18

Download-list Command (since 3.0) 19

Download-selection-prepare Command (since 4.0) 21

Download-selection-submit Command (since 4.0) 22

Download Command (deprecated) 23

Expand Command. 27

Edit Selection Prepare Command (since 4.0) 28

FEdit Command. 29

FInfo Command. 30

FUpdate Command. 31

Get Command. 32

Image Command. 33

Info Command. 37

InfoEdit Command. 41

List Command. 42

Livetree Command (since version 4.0) 44

Login Command. 45

Mail-Download-Basket (Since version 4.0) 46

MailCreate Command. 47

MailSend Command. 48

MailQueryCreate Command (since version 4.0) 49

MailQuerySend Command (since version 4.0) 50

Move Command (since version 3.1) 51

Move To Tree Command (since version 3.1) 52

Search Command (since 3.0) 53

Show Selection Command (since 4.0) 56

Stats Command. 58

Tree Command. 60

Update Command. 61

Update Selection Command (since 4.0) 62

Upload POST. 64

Upload-status Command (since version 3.0.5) 65

View Command. 66

XML List Command (since version 4.0.1) 67

IPTC Field list 68


Overview

 

All the eRez functions available to a Web User are invoked by issuing the commands listed alphabetically below as part of a standard HTTP “get” or “post” request as well as a few special requests.

 

The command is selected by means of the “cmd” parameter as in this example:

 

http://www.yourserver.com:8080/erez4/erez?cmd=stats

 

This will invoke the “stats” command and return a HTML page with information about the server, provided that the user has been identified as a member of the “administrator” group. The additional parameters that can be passed to the individual functions are explained in this document. Note that parameters are case sensitive.

 

Command

Description

activate

Insert and load a new license key.

cancel

Cancel a download job in progress.

confirmdel

Make a HTML page to confirm deletion of a file or folder.

confirmdelselection

Confiorm deletion of the files in the current selection.

del

Delete a file or folder.

delselection

Delete the files in the current selection.

download-prepare

Present download options for an image.

download-submit

Submit an image to the download manager.

download-list

List and manage images in the download manager.

download

Multipurpose download function (for backwards compatibility only).

download-selection-prepare

Presents download options for the selected files.

download-selection-submit

Submits a job to the download manager for each of the files in the current selection.

edit-selection-prepare

Prepare a page for entry of metadata and angle for images in the current selection.

expand

Expand a Template and optionally log out a user.

fedit

Make a HTML page for editing a folder.

finfo

Make a HTML page with folder information.

fupdate

Update folder information and/or create a new sub-folder.

get

Get/Download the source image directly.

image

Request a real-time image.

info

Make a HTML page with image information.

infoedit

Make a HTML page for editing image information.

list

List files and folders as HTML.

livetree

Fetch folder information for the AJAX tree

login

Login a user.

mailcreate

Make a HTML page for e-mailing files and folders.

mail-download-basket

Send the contents of the download manager as a reference by email.

mailquerycreate

Create a HTML page with a form for sending selections as emails.

mailquerysend

Send an email to the recipient(s) and return a HTML page .

mailsend

Send image or folder reference as e-mail.

 

Continued on next page


 

 

Command

Description

move

Moves a file or folder to a new location.

moveto-tree

Displays a list of folders whereto a file or folder can be moved.

search

Lists files that match search criteria.

showselection

List files in the current selection

stats

Make a HTML page with Server Information.

tree

Make a HTML Page with a Hierarchical Folder Structure.

update

Update Image Information

update-selection

 

upload

Make a HTML Page for Upload.

upload-status

Get information about an upload operation in progress.

view

Make a HTML Page with a Image Viewer.

xmllist

Generate XML file and folder list for use with Synkron VIA

 

Four special cases exist when functions are invoked without a specifying “cmd” parameter:

 

1)       Cached real-time images are read via a “get” from the “magic” path “cache”.

 

2)       Packaged files ready for download are read via a “get” from the magic path “download.zip” or “download”.

 

3)       Data is uploaded by means of a “post” to the “magic” path “upload”.

 

4)       A SOAP method is invoked by means of “post” to the “magic” path “rpc”. The SOAP interface is an add-on product for eRez and described separately.


The Velocity Template Engine

 

Dynamic HTML pages and e-mail messages are created by means of Apache Velocity. Velocity is a Java-based template engine. It permits web page designers to reference variables and methods defined in Java code. Velocity separates Java code from the web pages, making the web site more maintainable over the long run and providing a viable alternative to Java Server Pages (JSPs) or PHP.

 

Velocity can be used to generate web pages, SQL, PostScript and other output from templates. It can be used either as a standalone utility for generating source code and reports, or as in this case an integrated component of other systems.

 

The complete documentation for Velocity is included in the eRez package. You should at least familiarize yourself with the Velocity User’s Guide.

 

You will almost certainly find that Velocity is fairly easy to understand and use compared to ASP or JSP and the eRez Imaging Server does not use many advanced features of Velocity.

 

The files containing the Velocity templates are placed in the WEB-INF/templates folder inside the erez2 folder and all references to template files are relative to this folder.

 

You can inspect, modify or create your own new templates using a simple text editor.

 

 

TIP: You can edit and update the template files while the server is running. Any changes that you make will take effect immediately. This is very convenient when experiment with new ideas because you get immediate feedback from the server.

 

 

 

 

TIP: In addition to the standard parameters made available to the templates by eRez, you can use any of the parameters passed to the command including your own special parameters.

 

Example: if calling the stats function as erez?cmd=stats&myname=Margrethe , then $myname in the template will be replaced by the string “Margrethe”.

 


The eRez Imaging Server Architecture

 

As illustrated below the eRez Server works on 3 different channels each optimized for a particular purpose.

 

 

 

1)       The real-time imaging channel is optimized for high speed image delivery of low to medium resolution images. The commands associated with this channel are only the “image” command and requests for cached images from the “magic” path “cache”.

.

 

2)       The Info channel is used for generating HTML pages and handling request for information, upload, update and deletion of folders and images and similar functions. Most of the commands described in this document will work on the info channel. The built in Browser application is implemented on top of these commands using only standard HTML with some JavaScript code.

 

3)       The asynchronous imaging channel is used for download of image data of any size including high-resolution color separations. The commands associated with the download channel are the “download” and “cancel” commands and request for data from the “magic” path “download”.

 

Note that the “FTP Uploader” in the diagram above can only be used via the optional SOAP interface.

 

 

TIP: If you only need to learn how to request dynamic images from eRez you will only have to learn about the “image” command.

 

 


Permissions

 

Most of the commands that can be performed by the eRez require the user to have certain permissions.

 

The permissions in use are:

 

·       View – for the current shared folder.

·       List – for the current shared folder.

·       Download – for the current shared folder.

·       Upload – for the current shared folder.

·       Edit – for the current shared folder.

·       Delete – for the current shared folder.

·       Administrator – membership of the “administrator” group.


Log file entries

 

The eRez Imaging server logs individual requests and their outcome to the Java Application Server’s log file. For instance Apache Tomcat stores the log files as text files in a directory called “logs”.

 

Below is two example entries created by the eRez servlet:

 

+,IMAGE,310,127.0.0.1,*,*,"Format Samples/TIFF/tukan.tif",OK,300

+,DOWNLOAD-POLL,0,127.0.0.1,*,*,"66cebd027b563660",OK

 

The log entries consist of several “fields” separated by commas. The first 8 fields are always present:

 

1)       Either a “+” or “-“ indicating whether or not access to the functions was granted or denied.

 

2)       The name of the function requested.

 

3)       The number of milliseconds spent on servicing the request.

 

4)       The IP number of the client from which the request was received.

 

5)       The users login, or “*” if the user hasn’t logged on-

 

6)       The role required to access the function.

 

7)       The target object, such as the name of a file or directory or a job id.

 

8)       “OK” if the function completed with no exceptions, or the name of a Java Exception encountered while attempting to carry out the function.

 

In addition each of the commands may add one or more extra fields as described in the reference for each command. Here is another log entry for an attempt to download a file without the proper permission:

 

-,DOWNLOAD-CREATE,110,127.0.0.1,*,?,"Format Samples/img.tif",OK

 

The meanings of the fields in this example are:

 

1)       The  “-“ indicates that the request was denied.

 

2)       “DOWNLOAD-CREATE” indicates that the request was to create a new Download jopb.

 

3)       “110” was the number of milliseconds spent servicing the request (roughly 1/10 of a second).

 

4)       “127.0.0.1” is the IP number of the client.

 

5)       The “*” indicates that the user wasn’t logged on-

 

6)       The “?” is the role required to perform the function (any known user).

 

7)       "Format Samples/img.tif" is the name of the file in question.

 

8)       “OK” means that the request was handled (or in this case: rejected) without encountering Java Exceptions.


 

User Parameter

 

In many cases a user element is accessible from the velocity templates when a user is logged into the server.

The following attributes are available for a user: Login, EMailAddress, FirstName and LastName.

In addition the methods inGroup() and getProperty() can be used to check for a group/role membership and read custom properties either defined in the users.xml file like in the example below or as returned by a custom user manager plug-in using LDAP, Lotus Notes or similar.

 

  <user login="user" password="password" email="user@yawah.com" firstname="eRez" lastname="User">

    <property key="type" value="very nice" />

    <property key="gender" value="female" />

    <member group="users" />

  </user>

 

In the above example the two custom properties “type” and “gender” is defined.

Session Parameter (since 4.1)

 

In most cases when returning HTML or other text data, a “session” parameter is accessible from the velocity template. The session can be used to store and retrieve information such as the user’s language and other preferences.

 

The following methods can be called on the session object:

 

getAttribute(key) – returns an attribute from the session.

setAttribute(key, value) – set/add the value for an attribute on the session.

removeAttribute(key) – remove an attribute from the session.

 

detectLanguage() – detect a language to use based on the HTTP header sent by the browser.

 

detectLanguage will return a “Language” object with the following attributes:

 

            code - ISO 639 language code

            displayname -  A name for displaying the language to the user.

            id - identifier used by eRez.

            country - Optional ISO 3166 2-letter code

            default – True if this language is the default eRez language (English).

Overriding HTTP Headers (since 4.1)

 

Most of the HTTP headers returned by eRez is controlled by the definitions in the XML file Rez4\src\WEB-INF\private\headers.xml.

 

For all request you can use the parameter “headers” to request that eRez use one of the sets of headers defined in headers.xml rather than the default. For example you can add “&headers=proxy” to have eRez return the headers defined in the “proxy” set.

 

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

 

Selector:

erez?cmd=activate

http method:

get or post

Required Permission:

Administrator

Description:

Insert the license code in the “license.xml” configuration file, load the new license and then redirects the Web browser to the status page (erez?cmd=stats). The function does not check if the license is valid or correctly formatted. A blank license will clear an existing license from the server.

Input Parameter:

Description:

Default Value:

adhoc

Always set this to “1” to have the server request login and password using HTTP basic authorization.

none

License

The license key including the initial <license> and final </license> tags.

obligatory

Output:

HTTP redirect to:  erez?cmd=stats

HTTP Errors:

UNAUTHORIZED (401).

Log entry

ADDLICENSE. (no extra parameters)

 

Cancel Command (deprecated)

 

Selector:

erez?cmd=cancel

http method:

get or post

Required Permission:

None (a valid job id is required).

Description:

Aborts a download job in process or in the download queue and redirects the browser back to the download status page.

This command is part of the original eRez 2.0 download system which has now been replaced by the new download-prepare, download-submit and download-list commands. Kept for backwards compatibility.

Input Parameter:

Description:

Default Value:

angle

Image Rotation in degrees (± 0-360)

0

bottom

Image Crop rectangle bottom value (0.0–1.0)

1

jobid

Unique job identifier as returned by the download command.

obligatory

left

Image Crop rectangle left value (0.0–1.0)

0

right

Image Crop rectangle right value (0.0–1.0)

1

top

Image Crop rectangle top value (0.0–1.0)

0

vtl

HTML template for use as parameter in the HTTP redirect

prez/getjob.html

Output:

HTTP redirect to: "erez?cmd=download&jobid=jobid&vtl=vtl

- plus  top,left,bottom,right and angle if they were passed as input.

HTTP Errors:

GONE (410).

Log entry

DOWNLOAD-CANCEL. (no extra parameters)

 


Confirmdel Command

 

Selector:

erez?cmd=confirmdel

http method:

get or post

Required Permission:

Delete permission for the share.

Description:

Builds a HTML page prompting the user to confirm deletion of a file or folder.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

The image or folder to delete

obligatory

vtl

HTML template for output.

confirmdelete.html (?)

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

filename

The name of the file or folder without path information.

isfolder

“1” if the target is a folder. Otherwise undefined.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

CONFIRM-DELETE. (no extra parameters)

 


 

Confirmdelselection Command (since version 4.0)

 

Selector:

erez?cmd= confirmdelselection

http method:

get or post

Required Permission:

None.

Description:

Builds a HTML page prompting the user to confirm deletion the selected files.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

deletable

The number of selected files which can be deleted.

total

The total number of selected files.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

CONFIRM-SELECTION-DELETE. (no extra parameters)


Del Command

 

Selector:

erez?cmd=del

http method:

get or post

Required Permission:

Delete permission for the share.

Description:

Deletes a file or folder and

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

The image or folder to delete

obligatory

vtl

HTML template for output.

deleted.html (?)

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

deleted

“1” if the file or folder was successfully deleted. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

filename

The name of the file or folder without path information.

parent

The parent folder of the file or folder that was deleted. Only defined if the file or folder was successfully deleted. URL encoded since 4.1.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

DELETE. (no extra parameters)


Delselection Command (since version 4.0)

 

Selector:

erez?cmd=delselection

http method:

get or post

Required Permission:

None

Description:

Deletes the selected files.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

vtl

HTML template for output.

obligatory

Output:

HTML page.

 

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

deleted

The number of files which was successfully deleted.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

DELETE-SELECTION. (no extra parameters)

 

 


Download-prepare Command (since 3.0)

 

Selector:

erez?cmd= download-prepare

http method:

get or post

Required Permission:

Download permission for the share.

Description:

Presents download options for an image

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

The source image

obligatory

vtl

HTML template for output.

download.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

formats

List of downloadable formats. Each template has a “Name” and a “Description” attribute.

profiles

List of available ICC profile. Each profile has two name properties: “URLName” and “HTMLName” for use as a URL parameter and as readable HTML respectively.

In addition all the parameters from the Info command are included.

Log entry

DOWNLOAD-PREPARE. (no extra parameters)

 


Download-submit Command (since 3.0)

 

Selector:

erez?cmd=download-submit

http method:

get or post

Required Permission:

Download permission for the share.

Description:

Submits a job to the download manager or returns a warning page if scaling exceeds the permitted maximum. The “download manager” is identified by a collection id which is stored in the session data (cookie). If no collection id is found a new will be created.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

angle

Image Rotation in degrees (± 0-360)

Template value

bottom

Image Crop rectangle bottom value (0.0–1.0)

Template value

dpi

Image resolution.

Template value.

filename

Suggested Output Filename (since 4.0)

Source filename

format

Image file format. Legal values are:

a)       “eps”

b)      “jpeg”

c)       “pdf”

d)      “tiff”

 

More formats can be implemented by means of PlugIns.

Template value.

height

Target image height in pixels. Used with respect to the aspect ratio.

Template value.

icc

Image ICC Profile description.

Template value.

left

Image Crop rectangle left value (0.0–1.0)

Template value

path

The name of a path to use instead of the default clipping path (if any).

The value “-“ means no clipping path.

none

right

Image Crop rectangle right value (0.0–1.0)

Template value

src

The source image

obligatory

tmp

The download template to use for conversion. If no template is specified the source file will be added to the download manager.

none

top

Image Crop rectangle top value (0.0–1.0)

Template value

upscale

Specifies how to do interpolation in case the source image does not have sufficient resolution to honor the output. If undefined the value from the template will be used. Legal values are:

 

a)       max – Choose the maximum size allowed by the template.

 

b)      Ignore – Ignore the warning and scale as needed.

Template value

vtl

HTML template for redirection.

downloadmanager.html

warnvtl

HTML template warning when the image is scaled beyond the allowed maximum.

downloadwarning.html

width

Target image width in pixels. Used with respect to the aspect ratio.

Template value.

Output:

Redirection to: erez?cmd=download-list&collection=collectionid&vtl=vtl

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

Note these parameters are only used when building the warning page.

src

The eRez path to the image.

upscale

The scaling in percent.

Log entry

DOWNLOAD-SUBMIT, name of template, optional IGNORE-SCALING or USE-MAX-SCALING

 

 

Downloading Data (since 3.0)

 

Selector:

download.zip

http method:

get or post

Required Permission:

None. The collection ID must be known.

Description:

Send an individual file or all files from a download manager as a ZIP file. The ZIP file is created on-the-fly while the data is sent.

Input Parameter:

Description:

Default Value:

src

A collection ID or a collection ID plus “/filename” to retrieve an individual file from the collection.

none

Output:

A ZIP file with a name on the form: Download_yyyy_MM_dd_HH_mm_ss.zip,

where yyyy_MM_dd-HH_mm represents the current date and time on the form  year, month, day, hour, minute and seconds.

HTTP Errors:

NOT_FOUND(404)

Log entry

DLMGR-SEND, zip filename, total number of bytes sent (uncompressed).


 

Download-list Command (since 3.0)

 

Selector:

erez?cmd=download-list

http method:

get or post

Required Permission:

None (the collection id must be known or stored in the session data).

Description:

Presents the contents of a download manager collection and optionally removes files and jobs from the collection.

Input Parameter:

Description:

Default Value:

charset

Character encoding for the HTML page

As defined in the system configuration

clear

The position of a job/file to remove from the collection. Starting with 0 for the first element.

none

clearall

If this is set to “1” all jobs and files are removed from the collection,

0

collection

The ID of the download manager collection

Value from session cookie. If none is available a new collection will be created.

src

The image or folder to delete

obligatory

vtl

HTML template for output.

downloadmanager.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

collection

The download manager collection ID.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

 

Continued on next page


Download-list Command, continued

 

 

downloaditems

An array of items with the following attributes:

completed : true if the job is completed and ready to download.

percentCompleted : the percentage of the job completed.

status : the job status code as listed below.

message : error message from the image processor.

top : top cropping-

left : left cropping.

bottom : bottom cropping.

right :right cropping.

angle : rotation in degrees.

encodedSrc : URL encoded path to the source image.

fileName : URL encoded name of the destination file.

size : Human readable size of the destination file.

rawSize : the size of the destination file in bytes.

position : the position of this element in the array (first is zero).

 

Possible values for the job status code are:

1)         Waiting in Queue.

2)         Image is being processed.

3)         Image is being packed for transmission.

4)         Package complete and ready for download.

5)         Job failed.

6)         Job cancelled by the user.

7)         Insufficient source image data.

8)         In transit for FTP upload

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

filecount

The number of files in the collection.

percentcomplete

The overall percentage completed of all jobs in the collection.

totalsize

Human readable size of all files in the collection.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

DLMGR-LIST, Collection ID

 


Download-selection-prepare Command (since 4.0)

 

Selector:

erez?cmd=download-selection-prepare

http method:

get or post

Required Permission:

none

Description:

Presents download options for the selected files

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

vtl

HTML template for output.

download-selection.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

formats

List of downloadable formats. Each template has a “Name” and a “Description” attribute.

profiles

List of available ICC profile. Each profile has two name properties: “URLName” and “HTMLName” for use as a URL parameter and as readable HTML respectively.

total

The total number of files in the selection.

downloadable

The number of files in the selection for which the user has download permission.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

DOWNLOAD-SELECTION-PREPARE. (no extra parameters)

 


Download-selection-submit Command (since 4.0)

 

Selector:

erez?cmd=download-selection-submit

http method:

get or post

Required Permission:

none

Description:

Submits a job to the download manager for each of the files in the current selection which the user has download permission for. The “download manager” is identified by a collection id which is stored in the session data (cookie). If no collection id is found a new will be created.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

angle

Image Rotation in degrees (± 0-360)

Template value

bottom

Image Crop rectangle bottom value (0.0–1.0)

Template value

dpi

Image resolution.

Template value.

format

Image file format. Legal values are:

e)       “eps”

f)        “jpeg”

g)      “pdf”

h)       “tiff”

Template value.

height

Target image height in pixels. Used with respect to the aspect ratio.

Template value.

icc

Image ICC Profile description.

Template value.

left

Image Crop rectangle left value (0.0–1.0)

Template value

right

Image Crop rectangle right value (0.0–1.0)

Template value

tmp

The download template to use for conversion. If no template is specified the source file will be added to the download manager.

none

top

Image Crop rectangle top value (0.0–1.0)

Template value

vtl

HTML template for redirection.

downloadmanager.html

width

Target image width in pixels. Used with respect to the aspect ratio.

Template value.

prefix

Optional filename prefix (since 4.1)

none

postfix

Optional filename postfix (since 4.1)

none

Output:

Redirection to: erez?cmd=download-list&collection=collectionid&vtl=vtl

HTTP Errors:

BAD REQUEST (400)

Log entry

DOWNLOAD-SELECTION-SUBMIT, download manager ID, name of template.

 


Download Command (deprecated)

 

This it the original Download command from eRez version 2.0. It has now been replaced by the new download-prepare, download-submit and download-list commands but kept for backwards compatibility. It is among the most complex commands that can be issued to the eRez server and has therefore been changed into several independent commands in version 3.0.

 

Selector:

erez?cmd=download

http method:

get or post

Required Permission:

Download permission for the share. No permission is needed to check the status of a job in progress because the unique and hard-to-guess job-id is required.

Description:

The download command can perform 3 different functions depending on the parameters passed:

1)       Create a HTML page with a list of downloadable formats and other controls.

2)       Submit a job to the queue.

3)       Poll for status of an existing job.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

angle

Image Rotation in degrees (± 0-360)

Template value

bottom

Image Crop rectangle bottom value (0.0–1.0)

Template value

charset

Character encoding for the HTML page

As defined in the system configuration

dpi

Image resolution.

Template value.

filename

Suggested Output Filename (since 4.0)

Source filename

format

Image file format. Legal values are:

i)         “eps”

j)         “jpeg”

k)       “pdf”

l)         “tiff”

Template value.

height

Target image height in pixels. Used with respect to the aspect ratio.

Template value.

icc

Image ICC Profile description.

Template value.

jobid

Unique job identifier. Whenever a jobid is specified the function will return status information for an existing job.

 

When no jobid is specified the value of the “tmp” parameter decides which function should be invoked.

none

left

Image Crop rectangle left value (0.0–1.0)

Template value

right

Image Crop rectangle right value (0.0–1.0)

Template value

src

The master image to download.

obligatory

 

Continued on next page


Download Command  (deprecated), continued

 

tmp

The download template to use for conversion or either:

 

a)       “.” - to build a HTML page with a list of available download templates. or

 

b)      “” (blank) – to download the original master image.

none

path

The name of a path to use instead of the default clipping path (if any).

The value “-“ means no clipping path.

none

top

Image Crop rectangle top value (0.0–1.0)

Template value

upscale

Specifies how to do interpolation in case the source image does not have sufficient resolution to honor the output. If undefined the value from the template will be used. Legal values are:

 

c)       max – Choose the maximum size allowed by the template.

 

d)      Ignore – Ignore the warning and scale as needed.

Template value

vtl

HTML template for output or redirection.

prez/download.html

(when making a list of formats available)

 

prez/getjob.html (when submitting a new job or  getting information about an existing job).

width

Target image width in pixels. Used with respect to the aspect ratio.

Template value.

zip

Controls if the file should be delivered zip compressed (1) or not (0). Since 2.5.2.

0

Output:

When making a HTML Page with Download options or polling for job status:

 

HTML Page.

 

When creating a new job, a HTTP redirect to: erez?cmd=download&jobid=jobid&vtl=template&top=top&left=left

&bottom=bottom&right=right&angle=angle[&path=path]

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

 

Continued on next page


Download Command (deprecated), continued

 

Template Parameter:

Description:

angle

Image Rotation in degrees (± 0-360)

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

bottom

Image Crop rectangle bottom value (0.0–1.0)

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

filename

The name of the file or folder without path information.

formats

List of downloadable formats. Each template has a “Name” and a “Description” attribute.

job_file

Path to file ready for download. Set when polling for job status.

job_id

The unique job identifier. Set when polling for job status.

job_message

Optional error messages from the image processor. Set when polling for job status.

job_percentcomplete

Percentage completed. Set when polling for job status.

job_position

The jobs current position in the job queue. Set when polling for job status.

job_processtime

Number of seconds used to prepare the image. Set when polling for job status.

job_status

Status of the job. Possible values are:

1)       Waiting in Queue.

2)       Image is being processed.

3)       Image is being packed for transmission.

4)       Package complete and ready for download.

5)       Job failed.

6)       Job cancelled by the user.

7)       Insufficient source image data. Must prompt user for action.

8)       In transit for FTP upload.

Set when polling for job status.

left

Image Crop rectangle left value (0.0–1.0)

photoshop_clippath

The name of the current clipping path or undefined.

photoshop_clippath_url

The URL encoded name of the current clipping path or undefined. (Since version 2.5.1).

 

Continued on next page


Download Command (deprecated), continued

photoshop_paths

An optional array of clippath information records.

Each record has the following fields:

1)       name – the name of the path.

2)       encodedname – URL encoded version of the name (since version 2.5.1).

3)       top – the top y coordinate of the bounding box (0.0 - 1.0).

4)       left – the left x coordinate of the bounding box (0.0 - 1.0).

5)       bottom – the bottom y coordinate of the bounding box (0.0 - 1.0).

6)       right – the right x coordinate  of the bounding box (0.0 - 1.0).

profiles

List of available ICC profile. Each profile has two name properties: “URLName” and “HTMLName” for use as a URL parameter and as readable HTML respectively.

right

Image Crop rectangle right value (0.0–1.0)

src

URL encoded eRez path to the source image.

templates

List of real-time templates. Each template has a “Name” and a “Description” attribute. Used for making the “Make URL” page.

top

Image Crop rectangle top value (0.0–1.0)

upscale

Required scaling of source image. Set when polling for job status.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entries

1)       DOWNLOAD-CREATE, Possible extra fields:

 

a)       The name of the selected template.

 

b)      REDIRECT indicating that the job was created and the client is redirected to the “DOWNLOAD-POLL” page.

 

c)       SCALE-WARNING indicating that a arning was issued to the user about  scaling beyond the maximum.

 

d)      IGNORE-SCALING indicating that scaling beyond the maximum was explicitly allowed by the user.

 

e)       USE-MAX-SCALING indicating that the size of the image was limited to the maximum by the user.

 

f)        MAKE-CHOICES indicating that a list of available templates was retured.

 

2)       DOWNLOAD-POLL (no extra parameters)

 

3)       DOWNLOAD-DATA. , Possible extra fields:

 

a)       ABORTED indicating that the transfer was aborted-

 

b)      The number of bytes transferred,

 


Expand Command

 

Selector:

erez?cmd=expand

http method:

get or post

Required Permission:

none

Description:

Simply expand a template with Velocity and optionally log out the current user by clearing the session’s user record.

Input Parameter:

Description:

Default Value:

logout

Set to “1” to log out current user.

none

vtl

HTML template for output.

none

Output:

HTML page.

HTTP Errors:

none

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

languages

A list of language objects describing installed languages as described under Session Parameter. Since 4.1.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

EXPAND. (no extra parameters)

 


 

Edit Selection Prepare Command (since 4.0)

 

Selector:

erez?cmd=edit-selection-prepare

http method:

get or post

Required Permission:

none

Description:

Prepare a page for entry of metadata and angle for images in the current selection.

Input Parameter:

Description:

Default Value:

vtl

HTML template for output.

none

Output:

HTML page.

HTTP Errors:

none

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

total

Total number of files in the selection

permitted

The number of files in the selection which the user has permission to update.

editable

The number of files in the selection which the user has permission to update and in a format which supports updating IPTC metadata.

rotatable

The number of files in the selection which the user has permission to update and in a format which supports rotation.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

EDIT-SELECTION-PREPARE. (no extra parameters)

 


FEdit Command

 

Selector:

erez?cmd=fedit

http method:

get or post

Required Permission:

Edit permission for the share.

Description:

Create a HTML page for editing folder properties and optionally create a new subfolder. The server will look inside the folder for a text file named “erezinfo.txt” and display it’s contents.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

URL encoded eRez path to the folder.

obligatory

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

description

HTML escaped contents of the “erezinfo.txt” file if it exists. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

foldername

Unless the folder is a share at the root level, foldername will contain the name of the folder that can be used for editing. Otherwise undefined.

pathname

The full path of the folder.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

FEDIT. (no extra parameters)

 


 

FInfo Command

 

Selector:

erez?cmd=finfo

http method:

get or post

Required Permission:

List permission for the share.

Description:

Create a HTML page with folder information. The server will look inside the folder for a text file named “erezinfo.txt” or “erezinfo.html” and display it’s contents. If none of the files can be found it will look in the parent folder and so forth until it reaches the root of the file system. If an “erezinfo.txt” file is found it will be passed to the template as “description”. If no “erezinfo.txt” is found but a “erezinfo.html” is found, the later will be returned as is and the template is not used.

 

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

URL encoded eRez path to the folder or a file inside it.

obligatory

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

description

HTML escaped contents of the “erezinfo.txt” file if it exists. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

pathname

The full path of the folder or file.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

FINFO. Possible extra parameter: ABORTED indicating thatteh transfer of an HTML file was aborted by the client.

 


FUpdate Command

 

Selector:

erez?cmd=fupdate

http method:

get or post

Required Permission:

Edit permission for the share.

Description:

Update/add/remove the folder description, optionally rename the folder and/or create a new subfolder.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

URL encoded eRez path to the folder.

obligatory

foldername

New name for the folder. If the value is different from the current name the folder will be renamed.

none

description

New description for the folder. Will be written to erezinfo.txt. If this parameter has no value or is missing th existing file if any will be deleted.

none

makefolder

Setting this to any value except for a empty string will cause a new folder to be created.

none

newfolder

The name of a new folder to be created.

none

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

description

HTML escaped contents of the “erezinfo.txt” file if it exists. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

foldername

Unless the folder is a share at the root level, foldername will contain the name of the folder that can be used for editing. Otherwise undefined.

pathname

The full path of the folder.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

FUPDATE. (no extra parameters)

 


Get Command

(From version 2.5)

 

Selector:

erez?cmd=get

http method:

get or post

Required Permission:

Download permission for the share.

Description:

Download the original file without conversion.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

URL encoded eRez path to the file.

obligatory

vtl

HTML template for output in case the user is not authorized to download.

no-access.html

Output:

Binary data – or HTML in case the user wasn’t authorized.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

src

URL encoded eRez path to the source image.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

session

A session as described under Session Parameter. Since 4.1.

Log entry

DOWNLOAD-DIRECT. Possible extra fields:

 

c)       ABORTED indicating that the transfer was aborted.

 

d)      The number of bytes transferred

 

 


Image Command

 

Selector:

erez?cmd=image (or NO cmd parameter).

http method:

get or post

Required Permission:

View permission for the share.

Description:

The main command for requesting dynamic imaging from the real-time channel. The server will check if an up-to-date image with the specified parameter already exists in the cache and create it if it doesn’t. When the dynamic image is ready a HTTP redirect to the image in the cache is returned.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

autocrop

Set this to “1” to have eRez automatically crop the image as necessary to fit the specified width and height exactly. Since 4.0.

 

Since version 4.1.2 you can optionally change the anchor using values 2-9:

 

1)       middle center

2)       upper left

3)       upper center

4)       upper right

5)       middle left

6)       middle right

7)       lower left

8)       lower center

9)       lower right

 

none

 angle

Image Rotation in degrees (± 0-360)

Template value

bottom

Image Crop rectangle bottom value (0.0–1.0)

Template value

brightness

Brightness adjustment (0.0.-∞). Since 4.1.

1.0

clipcolor

Optional RGB background color used to render the clipping path or specified path (see path). The format is a standard RRGGBB value.

None

bordercolor

Optional RGB border color. This will append a border around the image. Default border size is 1 pixel on all 4 sides.

None

border

Optional default border size in pixels for all 4 sides. Maximum allowed size is 100 pixels.

1

bordertop,

borderleft,

borderbottom,

borderright

Optional override of border size for top,left, bottom and right side.

As specified by border or 1.

Continued on next page


Image Command, continued

 

expire

Make the result timeout after 5 minutes when the smart client side caching via redirection has been disabled.

Bye specifying a value of 0 the resulting image will never expire.

1

eyecon

“Eyecon” image (hotspot) position. Legal values are:

0)       None

1)       Upper-left

2)       Upper-right

3)       Lower-left

4)       Lower-right

Template value

fill

A 6 digit hexadecimal HTML RGB color value used to pad the image to make it fit the specified width and height exactly.

Template value

fillmode

Controls the way images are padded:

0: Horisontal and vertical padding.

1: Horisontal padding only.

2: Vertical padding only.

0

format

Image file format. Legal values are:

1)       jpeg

2)       png

3)       flash

4)       pdf

5)       eps

6)       tiff

Template value

height

Image Height in pixels. Used with respect to the aspect ratio.

Template value

 

Continued on next page


Image Command, continued

 

keepaspect

Using a value of “0” will force the server to return an image with exactly the specified width and height and ignore the aspect ratio of the source image. Since version 3.0.

Template Value (1)

left

Image Crop rectangle left value (0.0–1.0)

Template value

oposx

Position of the left edge of the overlay image in the range (0.0 – 1.0). Since version 3.0.

None. Overlay will be centered.

oposy

Position of the top edge of the overlay image in the range (0.0 – 1.0). Since version 3.0.

None. Overlay will be centered.

quality

JPEG quality. 0 = very poor, 100 = best.

Template value

right

Image Crop rectangle right value (0.0–1.0)

Template value

path

The name of an embedded path to render

None

redirect

Use smart client side caching via redirection. Since version 2.5.5 this can be disabled by specifying a value of 0.

1

save

Since version 4.0.7.

If this is set to “1” eRez will try to detect Internet Explorer and Opera browsers and modify the header values so that the result can be saved to disk without modification.

This will also disable the smart client side caching via redirection (see redirect above).

0

scale

Scale hint to help eRez pick the right resolution. Since version 4.0.

Calculated by the server

sharpen

Sharpening/blur (± 0-500)

Template value

src

URL encoded eRez path to the folder.

Obligatory

tmp

The real-time template to use.

“default” (since version 2.5.1)

top

Image Crop rectangle top value (0.0–1.0)

Template value

width

Image Width in pixels. Used with respect to the aspect ratio.

Template value

anc

SVG overlay anchor point.

Specifies where the SVG overlay is anchored.

lt = left top

rt = right top

lb = left bottom

rb = right bottom

c = center

c for center

 

Continued on next page


Image Command, continued

 

scl

SVG scale type.

Specifies how to intrepid the size of the SVG template.

absw = absolute width size in pixels

absh = absolute height size in pixels

absf = absolute fit size in pixels (fit in square box of size)

relw = relative in percent to width of the requested image

relh = relative in percent to height of the requested image

relf = relative in percent to requested image, automatically selecting height or width, so that the template is always within the image.

 

relf

sclval

SVG scale value.

Specifies the size of the SVG template.

If scl = rel then the value is in percent of the requested image. Range [0..100]

If scl = abs then the value is in pixels.

25

tplname

SVG template name.

Specifies the name of the SVG template to use.

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

The name specified in the real time template

SVG Parameters

In addition to the above parameters, there can be any number of custom defined parameters for SVG templates. If the parameter is defined in the real time template, the parameter will be substituted with the value of the parameters. For more information look at the documentation for using SVG templates.

none

zoomlevel

Set this to “1” to have eRez automatically crop the image to match the desired zoom level (percentage 1-100). Since 4.0

none

Output:

HTTP redirect to image in cache or direct binary image data in case the parameter redirect=0 was used.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Log entry

IMAGE. Possible extra fields:

 

e)       LOW MEMORY RETRY plus additional text indicating that a severe low memory condition was encountered.

 

f)        The number of milliseconds waiting for the image to be created,

 

 

 

TIP: Use the “Publish to Web” tool to experiment with the different parameters. This tool can create and preview the URLs for you as well as generate complete HTML pages with Zoom enabled images.


Info Command

 

Selector:

erez?cmd=info

http method:

get or post

Required Permission:

List permission for the share.

Description:

Create a HTML page with image information.

Input Parameter:

Description:

Default Value:

charset

Character encoding for the HTML page

As defined in the system configuration

src

URL encoded eRez path to the image.

obligatory

vtl

HTML template for output.

info.html

escape

Escape method used for the VTL parameters. Legal values are:

1)       html

2)       xml

3)       none

html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

src

URL encoded eRez path to the image

esrc

Encrypted eRez path to the image (since 4.0.6).

 

Continued on next page


Info Command, continued

 

exif_aperture

EXIF Aperture or undefined.

exif_artist

EXIF Artist or undefined.

exif_brightness

EXIF Brightness or undefined.

exif_colorspace

EXIF Color Space or undefined.

exif_copyright

EXIF Copyright or undefined.

exif_customrendered

EXIF Custom Rendered or undefined.

exif_datetime

EXIF Date and Time or undefined.

exif_description

EXIF Image Description or undefined.

exif_digitalzoomratio

EXIF Digital Zoom Ratio or undefined.

exif_digitizeddatetime

EXIF Date and Time of digitization or undefined.

exif_exist

Defined if the image contains EXIF data.

exif_exposurebias

EXIF Exposure Bias or undefined.

exif_exposureindex

EXIF Exposure Index or undefined.

exif_exposuremode

EXIF Exposure Mode or undefined.

exif_exposureprogram

EXIF Exposure Program or undefined.

exif_exposuretime

EXIF Exposure Time or undefined.

exif_flash

EXIF Flash or undefined.

exif_flashenergy

EXIF Flash Energy or undefined.

exif_focallength

EXIF Focal Length or undefined.

exif_focallengthin35mmfilm

EXIF Focal Length in 35mm Film or undefined.

exif_focalplanexres

EXIF Focal Pane X resolution or undefined.

exif_focalplaneyres

EXIF Focal Pane Y resolution or undefined.

exif_fstop

EXIF F Stop or undefined.

exif_isospeed

EXIF ISO Speed or undefined.

exif_lightsource

EXIF Light Source or undefined.

exif_make

EXIF Make or undefined.

exif_maxaperture

EXIF Maximum Aperture or undefined.

exif_meteringmode

EXIF Metering Mode or undefined.

exif_model

EXIF Model or undefined.

exif_originaldatetime

EXIF Date and Time of Image Capture or undefined.

exif_pixelheight

EXIF Height in Pixels or undefined.

exif_pixelwidth

EXIF Width in Pixels or undefined.

exif_scenecapturetype

EXIF Scene Capture Type or undefined.

exif_sensingmethod

EXIF Sensing Method or undefined.

 

Continued on next page


Info Command, continued

 

exif_shutterspeed

EXIF Shutter Speed or undefined.

exif_software

EXIF Software Used or undefined.

exif_spectralsensitivity

EXIF Spectral Sensitivity or undefined.

exif_subjectdistance

EXIF Subject Distance or undefined.

exif_subjectlocation

EXIF Subject Location or undefined.

exif_whitebalance

EXIF White Balance or undefined.

file_bytesize

The size of the file in bytes or undefined.

file_exist

Defined if the object is a file (always).

file_lastmodified

The date and time when the file was last modified or undefined.

file_path

File and path name (hidden if src was encrypted).

file_path

The eRez path and name of the file (hidden if src was encrypted).

file_size

The size of the file in bytes and "human readable".

img_bitsperchannel

The number of bits per channel for the image.

img_channels

The number of channels for the image.

img_colormodel

The image color model.

img_columns

The width of the image in pixels or undefined.

img_compression

The image copmpression scheme.

img_exist

Defined if the object is an image.

img_format

The image file format.

img_iccprofile

The ICC profile description or undefined.

img_resolutionlevels

The number of resolution levels found in the image file.

img_rows

The height of the image in pixels or undefined.

iptc_exist

Defined if the image contains IPTC meta data.

iptc_????

Any of the fields as defined in the IPTC Field List

opi_imageid

OPI Image ID (Since 3.1)

 

 

Continued on next page


 

photoshop_clippath

The name of the current clipping path or undefined.

photoshop_clippath_url

The URL encoded name of the current clipping path or undefined. (Since version 2.5.1).

photoshop_exist

Defined if the image contains Photoshop specific data.

photoshop_layers

An optional array of photoshop layer names (since version 4.0).

photoshop_url

The URL entered from File:GetInfo or undefined.

photoshop_paths

An optional array of clippath information records.

Each record has the following fields:

1)       name – the name of the path.

2)       encodedname – URL encoded version of the name (since version 2.5.1).

3)       top – the top y coordinate of the bounding box (0.0 - 1.0).

4)       left – the left x coordinate of the bounding box (0.0 - 1.0).

5)       bottom – the bottom y coordinate of the bounding box (0.0 - 1.0).

6)       right – the right x coordinate  of the bounding box (0.0 - 1.0).

preview_exist

Defined if the object can be represented by a preview image (since 2.5.5).

templates

An array of real-time templates.

Each with the following attributes:

Width : The width in pixels.

Height The height in pixels.

Name : The Name of the template.

 

If the element is referenced without specifying an attribute, the name is returned.

profiles

An array of ICC profiles, each with the following attributes:

URLName : URL Encoded name.

HTMLName : HTML encoded name.

NAME : Straight name.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

INFO. (no extra parameters)

 


 

InfoEdit Command

 

Selector:

erez?cmd=infoedit

http method:

get or post

Required Permission:

Edit permission for the share.

Description:

Create a HTML page with image information for editing.

Input Parameter:

Description:

Default Value:

charset

Character encoding for the HTML page

As defined in the system configuration

src

URL encoded eRez path to the image.

obligatory

vtl

HTML template for output.

info.html

escape

Escape method used for the VTL parameters. Legal values are:

4)       html

5)       xml

6)       none

html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

The parameters are identical to those of the “Info” command.

Please refer to the Info Command.

Log entry

EDIT. (no extra parameters)

 


List Command

 

Selector:

erez?cmd=list

http method:

get or post

Required Permission:

List permission for the share. No permission is needed for the root level – but only shares to which the current user has list permission are included.

Description:

Builds a HTML page with a list of files and sub-folders in the folder.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

cols

Number of columns in the list

From system.xml configuration file.

page

The page number to display

1

rows

Number of rows in the list

From system.xml configuration file.

select

If the value is “all” then all files in the folder will be added to the current selection.

 

If the value is “none” then all files in the folder will be removed from the current selection.

none

src

The eRez path to the folder.

obligatory

vtl

HTML template for output.

list.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

candownload

Set to “true” if download is enabled for this share. Otherwise undefined.

curpage

Current page number

 

Continued on next page


List Command, continued

 

Template Parameter:

Description:

current

Information about the current folder with the attributes “Name” and “Path”.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

files

A two dimensional list of elements in the list organized as rows and columns.  Each element has the following attributes:

 

IsDir : true if the element is a folder.

 

IsFile : true if the element is a file. Ig the element is neither a folder or a file it is an empty element.

 

Selected : true if the element is checked (part of the current selection).

 

StraightName : Plaintext name of the element.

 

Name: HTML encoded name of the element.

 

Name(maxlen) : HTML encoded name of the element limited to maxlen characters. If the name must be truncated an ellipsis character is added at the end.

 

EncodedName : URL encoded name of the element.

 

ID : A “random” ID unique for this page

 

EncodedURL The full encoded path and name for the image.Since version 3.0.

 

Method “getInfo()” (from version 2.5): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned. The result is HTML encoded.

 

Method “getInfoUnencoded ()” (from version 3.0): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned.The result is unencoded.

 

Method “getInfoXML ()” (from version 3.0): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned.The result is XML encoded.

 

Continued on next page


List Command, continued

 

lastpage

Last page number (number of pages)

nextpage

Next page number

parents

A list with Information about all parent folders. Each with the attributes “Name” and “Path”.

prevpage

Previous page number

src

The eRez path to the folder.

esrc

An encrypted block with the eRez path to the folder as well as the user’s credentials (username and password) used to repeat the listing without first logging on. Since version 3.0.5.

title

Suggested title for the page (path + “*” )

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

LIST. (no extra parameters)

 

Livetree Command (since version 4.0)

 

Selector:

erez?cmd=livetree

http method:

get or post

Required Permission:

none

Description:

Returns folder information as required by Emanuel Borsboom’s LiveTree 0.1.2 project.

Input Parameter:

Description:

Default Value:

depth

Number of levels to return

obligatory

src

The eRez path to the folder.

/

Output:

HTTP redirect to one of the two URLs.

 

HTTP Errors:

NOT_FOUND(404)

 

Log entry

LIVE-TREE-ROOT. (no extra parameters)

 


 

Login Command

 

Selector:

erez?cmd=login

http method:

get or post

Required Permission:

none

Description:

Verify the user login and password and create a session attribute for the user.

Input Parameter:

Description:

Default Value:

fail-url

The URL to redirect to if the login fails (wrong login/password).

obligatory

login

User’s login .

obligatory

ok-url

The URL to redirect to if the login succeeds.

obligatory

password

User’s password.

obligatory

Output:

HTTP redirect to one of the two URLs.

HTTP Errors:

BAD_REQUEST(400)

Log entry

LOGIN. (no extra parameters)

 


Mail-Download-Basket (Since version 4.0)

 

Selector:

erez?cmd=mail-download-basket

http method:

Post

Required Permission:

None. The collection ID must be known.

Description:

Emails a download basket.

Input Parameter:

Description:

Default Value:

mail-template

The name of the template that are used for sending the mail.

None

to

The email address which the basket should be sent to.

None

from

The email address of the sender.

If the user is logged in the users email address.

subject

The subject of the email.

none

message

The body of the email.

none

basket

The collection ID of images to mailed

Value from session cookie. If none is available a new collection will be created.

filesize

The size of the basket

obligatory

numofimages

The number of images in the basket

obligatory

vtl

HTML template for output.

downloadmanager.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

MAIL-DOWNLOAD-BASKET. Collection ID

 


 

MailCreate Command

 

Selector:

erez?cmd=mailcreate

http method:

Get

Required Permission:

List permission for the share.

Description:

Create a HTML page with a form for sending emails.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

None

charset

Character encoding for the HTML page

As defined in the system configuration

src

The eRez path to the file or folder.

Obligatory

vtl

HTML template for output.

Obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

filename

The name of the file or folder without the path.

srcpath

The eRez path to the file or folder.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

CREATE-MAIL. (no extra parameters)

 


MailSend Command

 

Selector:

erez?cmd=mailsend

http method:

get or post

Required Permission:

List permission for the share.

Description:

Send an email to the recipient(s) and return a HTML page .

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

The eRez path to the file or folder.

obligatory

vtl

HTML template for output.

obligatory

mail-template

HTML template for the email.

obligatory

to

Email receiver address

obligatory

subject

Email subject

obligatory

from

Email sender address

obligatory

message

Email text message

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter

for the HTML page:

Description:

Note: as always all the input parameters are available as well.

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Template Parameter

for the EMail:

Description:

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

filename

The name of the file or folder without the path.

message

HTML formatted text message.

src

The eRez path to the file or folder.

Log entry

SEND-MAIL. (no extra parameters)

 


MailQueryCreate Command (since version 4.0)

 

Selector:

erez?cmd=mailquerycreate

http method:

get

Required Permission:

None

Description:

Create a HTML page with a form for sending selections as emails.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

query

Optional query string (for future use)

eRez will automatically save the current selection and generate a query to reload it.

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

query

The query needed to reload the selection.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

CREATE-QUERY-MAIL. (no extra parameters)

 


MailQuerySend Command (since version 4.0)

 

Selector:

erez?cmd=mailquerysend

http method:

get or post

Required Permission:

List permission for the share.

Description:

Send an email to the recipient(s) and return a HTML page .

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

query

The query needed to reload the selection.

obligatory

vtl

HTML template for output.

obligatory

mail-template

HTML template for the email.

obligatory

to

Email receiver address

obligatory

subject

Email subject

obligatory

from

Email sender address

obligatory

message

Email text message

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter

for the HTML page:

Description:

Note: as always all the input parameters are available as well.

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Template Parameter

for the EMail:

Description:

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

message

HTML formatted text message.

query

The query needed to reload the selection.

Log entry

SEND-QUERY-MAIL. (no extra parameters)

 

 


Move Command (since version 3.1)

 

Selector:

erez?cmd=move

http method:

get or post

Required Permission:

Delete permission for the source share and upload permission for the destination share.

Description:

Moved the file or folder to a new location.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

The eRez path to the source image or folder.

obligatory

dst

The eRez path to the destination folder

obligatory

vtl

HTML template for output.

moved.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

directory

“1” if the moved item was a directory. Otherwise undefined.

parent

Path to the parent folder of the source.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

MOVE, destination

 


 

Move To Tree Command (since version 3.1)

 

Selector:

erez?cmd=moveto-tree

http method:

get or post

Required Permission:

Delete permission for the share.

Description:

Create a HTML page with a hierarchical list of folders to which the source image or folder can be moved (for which the user has upload permission).

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

The eRez path to the source image or folder.

obligatory

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

tree

A list of nodes in the tree. Each node has the following attributes:

 

Node – Identifier for the node. Unique for the page.

 

Parent – The parent node’s identifier. Root level nodes have “foldersTree” as parent.

 

Folder – Name of the folder.

 

 Path – The eRez path to the folder.

 

src

Encoded path to the source image or folder.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

MOVETO-TREE. (no extra parameters)

 


Search Command (since 3.0)

 

Selector:

erez?cmd=search

http method:

get or post

Required Permission:

None. Only images in folders where the user has list permission are returned.

Description:

Builds a HTML page with a list of files matching the query. The list is sorted by relevance.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

cols

Number of columns in the list

From system.xml configuration file.

page

The page number to display

1

rows

Number of rows in the list

From system.xml configuration file.

select

If the value is “all” then all files in the folder will be added to the current selection.

 

If the value is “none” then all files in the folder will be removed from the current selection.

none

query

The query string

obligatory

query2

Optional second query string. The result will match both query and query2 (AND). Since version 4.0.

none

src

Optional encoded path to a source folder to which the search will be limited. Since version 4.0.

none

vtl

HTML template for output.

searchresults.html

Output:

HTML page.

HTTP Errors:

NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

curpage

Current page number

 

Continued on next page


Search Command, continued

 

Template Parameter:

Description:

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

files

A two dimensional list of elements in the list organized as rows and columns.  Each element has the following attributes:

 

IsDir : true if the element is a folder.

 

IsFile : true if the element is a file. Ig the element is neither a folder or a file it is an empty element.

 

Selected : true if the element is checked (part of the current selection).

 

Score : A value between 0 and 100 describing the relevance or “score” of this search.

 

StraightName : Plaintext name of the element.

 

Name: HTML encoded name of the element.

 

Name(maxlen) : HTML encoded name of the element limited to maxlen characters. If the name must be truncated an ellipsis character is added at the end.

 

EncodedName : URL encoded name of the element.

 

ID : A “random” ID unique for this page

 

EncodedURL The full encoded path and name for the image.Since version 3.0.

 

Method “getInfo()” (from version 2.5): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned. The result is HTML encoded.

 

Method “getInfoUnencoded ()” (from version 3.0): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned.The result is unencoded.

 

Method “getInfoXML ()” (from version 3.0): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned.The result is XML encoded.

 

 

 


Search Command, continued

 

htmlquery

HTML encoded query string

lastpage

Last page number (number of pages)

nextpage

Next page number

prevpage

Previous page number

query

URL encoded query string

equery

An encrypted block with the query as well as the user’s credentials (username and password) used to repeat the query without first logging on. Since version 3.0.5.

title

Suggested title for the page (“Search Results” )

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

SEARCH, query, number of hits

 


 

Show Selection Command (since 4.0)

 

 

Selector:

erez?cmd=showselection

http method:

get or post

Required Permission:

None. Only files in the selection where the user has list permission are returned.

Description:

Builds a HTML page with a list of files in the current selection

Input Parameter:

Description:

Default Value:

charset

Character encoding for the HTML page

As defined in the system configuration

cols

Number of columns in the list

From system.xml configuration file.

page

The page number to display

1

rows

Number of rows in the list

From system.xml configuration file.

vtl

HTML template for output.

searchresults.html

Output:

HTML page.

HTTP Errors:

NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

curpage

Current page number

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

 

Continued on next page


 Show Selection Command, continued

 

Template Parameter:

Description:

files

A two dimensional list of elements in the list organized as rows and columns.  Each element has the following attributes:

 

Selected : true if the element is checked (part of the current selection).

 

StraightName : Plaintext name of the element.

 

Name: HTML encoded name of the element.

 

Name(maxlen) : HTML encoded name of the element limited to maxlen characters. If the name must be truncated an ellipsis character is added at the end.

 

EncodedName : URL encoded name of the element.

 

ID : A “random” ID unique for this page

 

EncodedURL The full encoded path and name for the image.Since version 3.0.

 

Method “getInfo()” (from version 2.5): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned. The result is HTML encoded.

 

Method “getInfoUnencoded ()” (from version 3.0): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned.The result is unencoded.

 

Method “getInfoXML ()” (from version 3.0): This method can be called with the name of any of the meta data fields known from the “Info” command such as “exif_digitizeddatetime” etc.. Note that the use of this method may impact performance of the list command since each of the files in the list will have to be opened before the list is returned.The result is XML encoded.

 

 

lastpage

Last page number (number of pages)

nextpage

Next page number

prevpage

Previous page number

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

SEARCH, query, number of hits

 Stats Command

 

Selector:

erez?cmd=stats

http method:

get or post

Required Permission:

Administrator

Description:

Create a HTML page with server information.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

vtl

HTML template for output.

stats.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403)

Template Parameter:

Description:

activitytime

Total number of seconds the server has been handling requests.

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

downloadtemplates

List of names for download templates.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”).

ftpmounts

List of defined FTP targets (for SOAP interface only).

hits

Total number of requests.

iccprofiles

List of ICC profile descriptions.

imagecount

Number of images on the server.

img_averagequeue

Average real-time image queue size.

img_jobs

Total real-time image jobs processed.

img_maxqueue

Maximum real-time image queue size.

img_threads

Number of real-time image processor threads.

licenses

List of licenses. Each element in the list contains another list with elements with a “key” and “value” attribute.

load

(activitytime * 100) / uptime

mounts

List of shares

 

Continued on next page


Stats Command, continued

 

peaktreads

Maximum number of concurrent hits

prez_averagequeue

Average asynchronous image queue size.

prez_jobs

Total asynchronous image jobs processed.

prez_maxqueue

Maximum asynchronous image queue size.

prez_threads

Number of asynchronous image processor threads.

started

Date and time the server was started.

system_cpus

Number of CPUs in the server.

system_freememory

Amount of free memory in the Java VM.

system_jai

Java Advanced Imaging version information.

system_java

Java Advanced Imaging version information.

system_os

Operating system information.

system_server

Java Server information.

system_time

Current date and time.

system_totalmemory

Total memory allocated to the Java VM.

templates

List of real-time template names.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

uptime

Number of seconds the server has been running.

version

eRez version information

Log entry

STATS. (no extra parameters)

 

 


Tree Command

 

Selector:

erez?cmd=tree

http method:

get or post

Required Permission:

List permission for the share. No permission is needed for the root level – but only shares to which the current user has list permission are included.

Description:

Create a HTML page with a hierarchical list of folders.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

src

The eRez path to the root folder of the tree.

obligatory

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

tree

A list of nodes in the tree. Each node has the following attributes:

 

Node – Identifier for the node. Unique for the page.

 

Parent – The parent node’s identifier. Root level nodes have “foldersTree” as parent.

 

Folder – Name of the folder.

 

 Path – The eRez path to the folder.

 

srcpath

The eRez path to the file or folder.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

TREE. (no extra parameters)

 


Update Command

 

Selector:

erez?cmd=update

http method:

get or post

Required Permission:

Edit permission for the share.

Description:

Update the IPTC information for an image file and optionally rename it.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

filename

New filename. If specified the file will be renamed.

 

iptc_????

Any of the fields defined in the IPTC Field List.

blank

redirect

URL to redirect to. The URL encoded eRez path to the file will be appended to the URL.

 

src

The eRez path to the root folder of the tree.

 

vtl

HTML template for output.

 

Output:

HTTP Redirect to the specified URL.

 

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404), BAD_REQUEST(400)

 

Log entry

UPDATE. (no extra parameters)

 

 


 

Update Selection Command (since 4.0)

 

Selector:

erez?cmd=update-selection

http method:

get or post

Required Permission:

None. Only images supporting updates and for which the user has the necessary permission is actually updates.

Description:

Update the IPTC information and rotation for images in the current selection.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

angle

Optional rotation in degrees.

blank

iptc_????

Any of the fields described in the IPTC Field List.

blank

redirect

URL to redirect to. The URL encoded eRez path to the file will be appended to the URL.

vtl

HTML template for output.

Output:

HTTP Redirect to the specified URL.

HTTP Errors:

BAD_REQUEST(400)

Log entry

UPDATE-SELECTION. (no extra parameters)

 


Upload Command

 

Selector:

erez?cmd=upload

http method:

get or post

Required Permission:

Upload permission for the share.

Description:

Create a HTML page with a form for uploading.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

src

The eRez path of the target folder.

obligatory

vtl

HTML template for output.

upload.html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

ticket

A unique hard-to-guess ticket that must be returned with the uploaded data.

srcpath

The eRez path to the file or folder.

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

UPLOAD-CREATE. (no extra parameters)

 


 

Upload POST

 

Selector:

upload

http method:

post

Required Permission:

No permission is needed because the unique and hard-to-guess ticket is required.

Description:

Receive uploaded data. Data can both be ZIP archives and individual image files in JPEG, FlashPix or TIFF formats. Image in JPEG format or TIFF without pyramid extensions will be converted using the download template specified. An optional e-mail can be sent as a receipt to the sender or someone else.

Input Parameter:

Description:

Default Value:

(FILE)

Any number of files can be included.

 

format

Name of the download-template to use for conversion of uploaded images.

master-tiff

Iptc_????

Any of the fields described in the IPTC Field list. Since version 4.0.

blank

overwriteIPTC

If “true” all existing IPTC data will be replaced.

false

mail-from

E-mail address of “sender”

blank

mail-subject

Subject of the E-Mail

Upload Receipt

language

Language used for the email receipt. Since 4.1.

en

mail-template

The template to use for the e-mail receipt.

mail/upload-receipt.html

mail-to

E-mail address of the recipient.

 

makefolder

If defined a new folder will be created with the name from “newfolder”

 

newfolder

Name of the new folder where images should be placed.

 

redirect

The page to redirect to when the upload has been unpacked.

 

sendmail

If defined an E-mail is sent to “mail-to”.

 

ticket

The unique ticket created by the upload command.

 

Output:

HTTP redirect to redirect + “&uploadcount=” + (number of image files received).

HTTP Errors:

BAD_REQUEST (400)

Log entry

UPLOAD-DATA. (no extra parameters)

 

Note: The form posted must be encoded as multipart/form-data like this:

 

<form action="upload" method="post" enctype="multipart/form-data" name="upload">

</form>


Upload-status Command (since version 3.0.5)

 

Selector:

erez?cmd= upload-status

http method:

get or post

Required Permission:

None. A valid ticket is required.

Description:

Returns status information about a file transfer in progress.

Input Parameter:

Description:

Default Value:

ticket

The unique hard-to-guess ticket returned by the upload command.

obligatory

vtl

HTML template for output.

obligatory

Output:

HTML page.

HTTP Errors:

 

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

ticket

The unique hard-to-guess ticket returned by the upload command.

progress

A status object with the following attributes:

PercentCompleted : percentage completed

TotalSize : total size in bytes

TotalSizeText : total size in readable text (e.g. 11 Mbyte).

UploadedSize : the number of bytes transferred so far.

UploadedSizeText : the amount of data transferred so far as readable text.

Ticket : the unique ticket,

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

Log entry

UPLOAD-STATS. (no extra parameters)


 

View Command

 

Selector:

erez?cmd=view

http method:

get or post

Required Permission:

View permission for the share.

Description:

Create a HTML page with a “Zoom Viewer”.

Input Parameter:

Description:

Default Value:

adhoc

Set this to “1” to have the server request login and password using HTTP basic authorization.

none

charset

Character encoding for the HTML page

As defined in the system configuration

bottom

Image Crop rectangle bottom value (0.0–1.0)

1

left

Image Crop rectangle left value (0.0–1.0)

0

right

Image Crop rectangle right value (0.0–1.0)

1

src

The eRez path to the image.

obligatory

tmp

Template to user for preview.

obligatory

top

Image Crop rectangle top value (0.0–1.0)

0

vtl

HTML template for output.

viewer.html

escape (since 3.1)

Escape method used for the VTL parameters. Legal values are:

7)       html

8)       xml

9)       none

html

Output:

HTML page.

HTTP Errors:

UNAUTHORIZED (401), FORBIDDEN(403), NOT_FOUND(404)

Template Parameter:

Description:

AUTHORIZED

“1” if the user has the necessary permission. Otherwise undefined.

candownload

“true” if download is enabled for this folder. Otherwise undefined.

DISABLED

“1” if the function is disabled for everybody. Otherwise undefined.

erez-url

eRez base URL (e.g. http://www.myserver.com/erez4/”)

src

The eRez path to the image with the cropping parameters appended.

templateheight

Template height in pixels.

templatewidth

Template width in pixels.

title

Page title

tmp

Template to use for preview.

 

Continued on next page
View Command, Continued

 

session

A session as described under Session Parameter. Since 4.1.

user

Contains information about the current user if logged in. Otherwise undefined. The available attributes and methods for the user are described in the User Parameter chapter.

In addition the View command includes all the metadata parameters identical to those of the “Info” command except for “templates” and “profiles” (Since version 3.1).

 

Please refer to the Info Command.

 

Log entry

Log entry

 

 

XML List Command (since version 4.0.1)

 

Selector:

erez?cmd= xmllist

http method:

get or post

Required Permission:

None. Only Shared Folders for which the user has list permission is included.

Description:

Returns a list of files and folder in Synkron VIA NetworkFolder format.

Input Parameter:

Description:

Default Value:

login

Optional User login.

optional

password

Optional user password.

optional

Output:

UTF-8 encoded XML document in Synkron VIA NetworkFolder format.

HTTP Errors:

 

Log entry

XML-LIST. (no extra parameters)

 


IPTC Field list

 

This is a complete list of all the IPTC field codes supported by the eRez imaging Server.

 

iptc_byline

The IPTC byline field or undefined.

iptc_bylinetitle

The IPTC byline title field or undefined.

iptc_caption

The IPTC caption field or undefined.

iptc_captionwriter

The IPTC caption writer field or undefined.

iptc_category

The IPTC category field or undefined.

iptc_city

The IPTC city field or undefined.

iptc_copyright

The IPTC copyright field or undefined.

iptc_country

The IPTC country field or undefined.

iptc_creationdate

The IPTC creation date field or undefined.

iptc_creationtime

The IPTC creation time field or undefined.

iptc_credit

The IPTC credit field or undefined.

iptc_exist

Defined if the image contains IPTC meta data.

iptc_copyright

The IPTC copyright field or undefined.

iptc_country

The IPTC country field or undefined.

iptc_creationdate

The IPTC creation date field or undefined.

iptc_creationtime

The IPTC creation time field or undefined.

iptc_credit

The IPTC credit field or undefined.

iptc_headline

The IPTC headline field or undefined.

iptc_keywords

A set of IPTC keyword fields or undefined.

Iptc_largetext

Large caption (since version 4.0)

iptc_objectname

The IPTC object name field or undefined.

iptc_originaltransmissionreference

The IPTC original transmission reference field or undefined.

iptc_program

The IPTC program field or undefined.

iptc_provincestate

The IPTC province-state field or undefined.

iptc_source

The IPTC source field or undefined.

iptc_specialinstructions

The IPTC special instructions field or undefined.

iptc_supplementalcategoriess

A set of IPTC supplemental categories fields or undefined.

iptc_urgency

The IPTC urgency field or undefined.

 

Continued on next page


 

IPTC Field list, Continued

 

iptc_tilesx

Number of horizontal images for 3D representations (since 2.5.5).

iptc_tilesy

Number of vertical images for 3D representations (since 2.5.5).

iptc_scenesets

3D Scene sequence definition (since 2.5.5).

iptc_fsi

Up to 32K of text data reserved for use by FSI Viewer.

iptc_fw_jobid

 FotoWare proprietary job id (since version 4)

iptc_fw_masterdocumentid

 FotoWare proprietary master document id (since version 4)

iptc_fw_shortdocumentid

 FotoWare proprietary short document id (since version 4)

iptc_fw_uniquedocumentid

 FotoWare proprietary unique document id (since version 4)

iptc_fw_ownerid

 FotoWare proprietary owner id (since version 4)

iptc_custom01, iptc_custom01 … iptc_custom20

20 custom fields as used by FotoWare and other software packages.