eRez Imaging Server 3.2

Integrating FSI Viewer

11-nov-2005

 

Copyright 2001-2005 YaWah.com. All Rights Reserved

 

 

 

 

 

What is FSI Viewer?. 2

Configuring FSI integration into eRez Image Browser 2

Enabling and Disabling FSI Viewer 2

Additional Configuration Options. 3

Configuring FSI Viewer 4

Configuring FSI Showcase Add-on. 5


 

What is FSI Viewer?

 

NeptuneLabs FSI Viewer ("Flash based Single Source Image Viewer") is an optional add-on for eRez Imaging Server 2.5.5 or later.

 

FSI Viewer offer an alternative and highly refined user interface for viewing high resolution 2D images compared to the standard HTML viewer that comes with eRez.

 

In addition the FSI Viewer can be used to display 3D images and ships with a nice range of advanced plug-ins that can be used for enhancing the online viewing experience.

 

The version of FSI Viewer that ships with eRez Imaging Server is a fully functional evaluation copy that needs to be licensed separately.

 

FSI Viewer requires Macromedia Flash version 5 or later on the client machine. As today the penetration of this browser plug-in exceeds 95% of all internet users.

 

Please note that this document is focused on FSI Viewer integration into eRez Imaging Server. A complete documentation of FSI Viewer and FSI Showcase Add-on offering a plug-in and parameter reference as well as a large number of examples is available as an Adobe PDF file here.

 

On-line resources like examples and tutorials as well as FSI Viewer updates are available at

http://www.fsi-viewer.com

 

 

Configuring FSI integration into eRez Image Browser

The configuration file "fsi.html" located in

 

[eRez root]/WEB-INF/templates/config/fsi.html

 

holds a number of parameters determining the integration of FSI Viewer and FSI Showcase Add-on into eRez Image browser and can be edited using a text editor of your choice.

Please note that you can disable options and write comments by starting a line with a double sharp, e.g.:
## this line will be ignored

 

Enabling and Disabling FSI Viewer

 

The HTML templates for eRez 2.5.5 and later has been configured to automatically detect support for Flash in the clients web browser and will automatically use the FSI Viewer when possible. The login page has a “Use Flash” checkbox where the user can enable or disable the FSI Viewer at will.

 

To disable the FSI viewer completely and switch back to using the HTML viewer you must change the "$fsi_enabled" setting as follows:

 

#set( $fsi_enabled = false )

 

This will disable the use of FSI entirely including the removal of the “Use Flash” checkbox on the login page.

 

Additional Configuration Options

$fsi_version

The version of FSI Viewer used with eRez Imaging Server. The "Publish to Web" section uses this value to determine available options for FSI Viewer and FSI Showcase Add-on.

 

$fsi_path

The absolute path to FSI setup directory. The "Publish to Web" section uses this value when creating the HTML code to make the code usable on external web pages.

 

$fsi_fpxbase

Base request FSI Viewer and FSI Showcase use to request image data from eRez Imaging Server.  This value will be added to the FSI HTTP query in the "Publish to Web" section.

To reduce the size of the required FSI HTML code it is recommended to remove this line and edit the "FPX Base" parameter in the FSI configuration file located in

 

[eRez root]/fsi3/_default.fsi

 

accordingly.

 

E.g. if you have setup eRez to the location "http://foo.com/erez3/" the FPXBase parameter should be changed to:

 

<FPX>

<ServerType value="eRez" />

      <Base value="http://foo.com/erez3/erez?src=" />

</FPX>

 

$fsi_fixed_width

Forces a fixed width of FSI Viewer in the "Info" and "Viewer" section of eRez image browser regardless of the aspect ratio of the source image.

If you comment out these parameters the viewer will be adjusted to the aspect ratio of the source image.

$fsi_fixed_height

See $fsi_fixed_width above.

 

$fsi_min_width

If you disabled $fsi_fixed_width and $fsi_fixed_height FSI Viewer size in the "Info" and "Viewer" section will be adjusted to the aspect ratio of the source image.

This parameter defines the minimum width of FSI Viewer.

$fsi_min_height

See $fsi_min_width above.

 

$fsi_menu_height

This value defines the height in pixels of FSI Viewer menu bar and is being used to subtract the height of the menu bar from the available space for the image view port when adjusting the viewer size to the source image dimension.

You might want to change this value when using a custom FSI Skin with a different height of the menu bar.

 

$fsi_skins

Defines the available options in the "FSI Skin" select boxes in the "Publish to Web" section.
FSI Skin files must be located in the [eRez root]/fsi3/skins/ directory.

You can add custom skins if available by adding an additional element to the array in the following form:

["Display Name", "File Name w/o extension"]

 

$fsi_viewer_presets

Defines the available options in the "Layout Preset " select boxes in the "Publish as FSI Viewer " section. The layout preset files must be located in the directory
[eRez root]/fsi3/config/viewer_presets/

You can add custom presets by creating an FSI configuration file in the directory mentioned above and adding an additional element to the array in the following form:

["Display Name", "File Name w/o extension"]

Please refer to the section "Configuring FSI Viewer" for a description of available FSI configuration options.

 

$fsi_showcase_presets

Defines the available options in the "Layout Preset " select boxes in the "Publish as FSI Showcase" section. The layout preset files must be located in the directory
[eRez root]/fsi3/config/showcase_presets/

You can add custom presets by creating an FSI configuration file in the directory mentioned above and adding an additional element to the array in the following form:

["Display Name", "File Name w/o extension"]

Please refer to the section "Configuring FSI Showcase" for a description of available FSI configuration options.

 

$fsi_languages

Defines the available options in the "Language" select boxes in the "Publish to Web" section.
FSI language files must be located in the [eRez root]/fsi3/languages/ directory.

You can add additional languages if available by adding an additional element to the array in the following form:

"File Name 1 w/o extension", "File Name 2 w/o extension", …

 

$fsi_plugins

Defines the available options in the "FSI Plug-ins" select boxes in the "Publish to Web" section. FSI Plug-in files must be located in the [eRez root]/fsi3/plugins/ directory.

You can add additional plug-ins if available by adding an additional element to the array in the following form:

"File Name 1 w/o extension", "File Name 2 w/o extension", …

 

 

Configuring FSI Viewer

 

FSI Viewer configuration is determined by XML configuration files and by an HTTP query attached to the "movie" parameter of the HTML object tag.

The "Publish to Web" section dynamically configures FSI Viewer by creating and adding an HTTP query (e.g. "&MenuAlign=TL").

If you plan to publish multiple images using the same configuration options it is recommended to edit or add a layout preset configuration file (see $fsi_viewer_presets in the previous chapter).

 

Using customized configuration presets offers the following advantages:

 

  1. You can select a layout preset instead of selecting options in the "publish as FSI Viewer" section over again
  2. You can alter the configuration of a large number of image by editing the layout preset file only
  3. Reduce the size of required HTML code for FSI Viewer
  4. Access to advanced configuration options not available via the "Publish to Web" interface

 

FSI Viewer documentation offers a comprehensive description and examples on configuration methods and options and is available as an Adobe PDF file here.

 

Configuring FSI Showcase Add-on

FSI Showcase configuration is determined by XML configuration files and by an HTTP query attached to the "movie" parameter of the HTML object tag.

The "Publish to Web" section dynamically configures FSI Showcase by creating and adding an HTTP query (e.g. "&MenuAlign=TL").

If you plan to publish multiple Showcases using the same configuration options it is recommended to edit or add a layout preset configuration file (see $fsi_showcase_presets in the previous chapter).

 

Using customized configuration presets offers the following advantages:

 

  1. You can select a layout preset instead of selecting options in the "publish as FSI Showcase" section over again
  2. Access to advanced configuration options not available via the "Publish to Web" interface (especially with custom FSI Skins)
  3. You can alter the configuration of a large number of showcases by editing the layout preset file only
  4. Reduce the size of required HTML code for FSI Showcase

 

FSI Viewer documentation offers a comprehensive description and examples on configuration methods and options and is available as an Adobe PDF file here.