Updating from FSI Server 2 to 2016

FSI Server 2016 not only introduces a whole set of new features, we also changed some of the implementation details underneath to be able to offer a state of the art imaging solution.

New storage format

The probably largest change is the format of the internal storage. The new storage format offers nearly a 1:1 source file relation,
which leads to less files and directories. This enables FSI Server 2016 to manage even larger installations. The new format takes a lot of load off the file system itself and simplifies backups of the storage.

Changed nomenclature

As FSI Server now allows image delivery directly from multi-resolution source images and also allows the delivery of any kind of asset provided, not all data is necessarily imported into the internal storage. Due to this change, some component names needed to be changed. These new names are used in various places, from logger configuration to the names of the configuration files:

  • importer -> source manager
  • importer profile -> source connector
  • core -> requestprocessor
  • server profile -> renderer
  • pyramid images -> multi resolution images

 

New Source Connector Types

A Source Connector defines a source directory and a set of rules on how to handle the content of a directory. It also defines the access restrictions that apply to the assets within the source directory.
The Source Connector type ‘Storage’ imports images to the storage for the best possible image delivery performance (like in previous versions). As of version 2016 of FSI Server, there are two new source connectors types that allow access to assets and images without the need to import them.
The source connector type ‘Multi-Resolution’ provides the ability to upload multi-resolution .tiff or .fpx files and accessing these directly using the same URL-syntax as you would for imported images. This feature is primarily aimed at customers with a large stock of multi-resolution images and makes it easier to migrate for users of imaging servers other than FSI Server.
The other new source connector type ’Static’ allows managing and serving static files such as PDFs and videos, which can be addressed via a simple URL.

Migration Scenarios

Before migrating a production system you should make yourself familiar with the new features and especially the changed configuration files. FSI Server 2016 is compatible with the previous versions regarding image URLs and FSI Viewer codesnips. This means existing codesnips and URLs can be used without change although this might mean you are not making use of any of the new features yet.

Pre-considerations

The change of the storage format makes a re-import of the image data inevitable. As in previous versions the import places a noticeable load on the system, this means the resources used for importing are not available for request processing. Depending on the amount of traffic the server is handling, this might have an impact on the server’s performance.

Two or more servers

If you have a mirror server setup then the recommended migration path would be to take one down at a time, perform a clean installation of FSI Server 2016 and let the server import all images before putting it back online. This method offers the maximum safety as it allows to re-run integration tests on the new server before putting it into production.

One server with more than 50% free disk space

The new storage format uses less files and the overall disk space is also reduced notably. Nevertheless the new storage also requires a considerable amount of disk space. If you have enough disk space to fit your current storage again, then you should consider deploying FSI Server 2016 in parallel to FSI Server 2 and configure it to access the same source images but a different storage location. This will leave your productive FSI Server 2 untouched and operative. The disadvantage over the first scenario is obvious and was mentioned above: the resources required for importing will not be available for image delivery. As in scenario 1 though, you will be able to test the FSI Server setup before putting it into production. Once the images have been imported and you have completed your tests, you can simply switch to FSI Server 2016, undeploy the now unused FSI Server 2 and delete the old servers storage directory.

One server with less than 50% free disk space

If you have only one server available and the available disk space does not satisfy the requirements for a copy of the storage, you can replace the FSI Server 2 installation with an FSI Server 2016 setup. After adapting the configuration files, FSI Server 2016 will notice that the configured storage location already contains an old storage version. It will then enable the built-in automatic migration mode and will serve images from the old storage that have not been imported into the new storage yet. Meanwhile, the server can access both the old and the new storage, but may be slower, since images are imported in the background. Images that have been imported into the new storage will be deleted from the old storage automatically, the required additional disk space is therefore reduced to a minimum.
Please note: This is not the recommended migration method for business-critical systems. We highly recommend setting up FSI Server 2016 in parallel as described in scenario 1 and 2 before touching the production system.

FSI Server Migration Assistant

As mentioned above the location and the names of the configuration files have changed. The contents of WEB-INF/config, WEB-INF/importer_profiles and WEB-INF/server_profiles has been consolidated and is now located in WEB-INF/config only.
FSI Server 2016 offers an automatic configuration migration to assist in applying the required changed to the configuration files.

In order to make use of this feature, create the migration directory (WEB-INF/migration) beneath the FSI Server 2016 webapp directory. Place all configuration and viewer files that need to be migrated. This means copying the following directories
from your old FSI Server 2 configuration into the migration directory: viewer, users, WEB-INF/config, WEB-INF/importer_profiles and WEB-INF/server_profiles or a subset thereof. Please ensure the migration directory and all files paced into it are readable and writable by the user running Tomcat.

On startup FSI Server 2016 will check for the existence of the migration directory and if present the configuration and viewer data will be integrated into the new configuration.

Any changes you have made to the FSI Server 2016 configuration prior to using the migration assistant will most likely be overwritten.
The migration assistant will log it’s progress or any errors to the systems standard error console, usually visible in the catalina logfile.

Please note: When migrating as described in scenario 2 on the previous page, then using the migration assistant will result in FSI Server 2016 using the same storage directory as the production FSI Server 2, which is not intended. To prevent this, please change the storage location to an empty directory in the copy of the settings.xml and importer.xml before using these files for the migration.

Limits of the migration assistant

FSI Server 2 licence keys are not valid for FSI Server 2016. Please see the section “Licensing” on the following page in order to learn how to obtain a new licence key.

The metadata search functionality has completely changed in FSI Server 2016. This setting can therefore not be migrated. For details on the search functionality please see the appropriate section on the following page.