Upgrading to Zoom Server 7.x (Linux)

The following instructions describe how to upgrade a Zoom Server installed on RedHat Enterprise Linux (version 6.7 or 7). These instructions assume you have downloaded the zoom-unix64.tar.bz2 from the Zoom Support Center.

Different installations may have items stored in different locations based on different Linux flavors. These instructions may not match precisely all Linux environments Zoom is installed in. Please use these instructions as the basis and adapt to your unique environment.

A new format for Audit logs is used from Zoom 7.5 onwards. So, the audit logs created with Zoom 7.3 are not accessible in Zoom 7.5.x. If you do not want to generate a new audit log index after the Zoom upgrade (could take time as per the size of your Zoom repository), then for upgrade to:

  • 7.5.0 – you need to apply this patch before upgrading to Zoom 7.5.0.
  • 7.5.1 onwards – you need to follow these steps before upgrading to Zoom 7.5.1 or above.

Zoom Server upgrade

These instructions should be followed for all Zoom servers, the MAM Server, Preview Server, Curator Server, and HADR peers, whichever are in use. Install on each server machine starting with the Zoom MAM Server.

Step 1: Checkpoint and stop services

  1. Stop services for Zoom (all Zoom services installed on the machine). The order in which to stop services is Zoom Curator, Zoom Preview, Zoom, and then Zoom HADR services.
    For information on how to restart / stop services, refer to Starting and Stopping Zoom Services (Linux) .
  2. Open server.xml from [ZoomInstallDir]/conf/.
  3. Under <autorestartspec>, set tag <autoRestartEnabled>as true
  4. Under <autorestartspec>, set tag <doCheckpoint>as true
    <autorestartspec>
    <frequency>7</frequency>
    <date>2014-06-28 18:30:00.0 UTC</date>
    <time>00:00</time>
    <autoRestartEnabled>true</autoRestartEnabled>
    <doCheckpoint>true</doCheckpoint>
    </autorestartspec>
  5. Save server.xml file and close it.
  6. Start services for Zoom (the order in which to start services is Zoom HADR, Zoom, Zoom Preview, and then Zoom Curator services). Wait till the checkpoint is complete. If there is a lot of data to checkpoint, then it will take some time. The checkpoint is complete when the Zoom Admin Console is accessible again. Alternatively, check the server_log for messages “checkpointing started” and “checkpointing ended” after the current restart time.
    To perform checkpointing using the Terminal, refer to Zoom Server checkpointing on restart .
  7. Stop services for Zoom (all Zoom services installed on the machine). The order in which to stop services is Zoom Curator, Zoom Preview, Zoom, and then Zoom HADR services.

Step 2: Backup files

Ensure that the following files/folders are copied to a safe location outside the Zoom installation folder.

  1. Navigate to [ZoomInstallDir]/ (this is usually located at $home$/evolphin/zoom)
  2. Back up the conf and db folders to a location outside the DAM folder.
    If your db folder is located outside the Zoom install directory [ZoomInstallDir]/, then you do not need to back it up. The db folder location is found from the server.xml file in the conf folder. Check the <defaultRoot> XML tag under <dbspec> for the db location.
  3. Back up the redo folder to your backup location as well.
    The redo folder location is found from the server.xml file in the conf folder. Check the <redoLogDir> XML tag under <dbspec> for the redo location. By default, the redo location is in the db folder.
  4. Back up the [ZoomInstallDir]/webcontext/servers/PreviewServer/cache/ folder if it exists.
  5. Back up the solr-db folder to save the existing Curator indexes. It is typically found under the db folder.
    The solr-db folder location is found from the curator-server.xml in the conf folder. Check the <solrDataDir> tag under <curatorconfig> for the solr-db location. By default, the solr-db location is in the db folder.
  6. If you have a working VideoFX setup, that you want to upgrade to the newer VideoFX or VideoLX then:
    1. Back up zoom.properties file on Zoom Client machines to save high-res, mid-res, and low-res suffixes for setting up these suffixes later.
    2. Back up hook.properties file on Zoom Client, Vantage Server, Ingest Server, and Zoom Server machines to save metadata properties based ingest format for setting up metadata for ingest later.
    3. Save details about PSAN and USAN locations and Vantage workflows in use.
  7. If you have a working VideoLX setup then, that you want to upgrade to the newer VideoFX or VideoLX then:
    1. Back up zoom.properties file on Zoom Client machines to save high-res, mid-res, and low-res suffixes for setting up these suffixes later.
    2. Back up hook.properties file on Zoom Client, Vantage Server, Ingest Server, and Zoom Server machines to save metadata properties based ingest format for setting up metadata for ingest later.
    3. Save your SQL Server details for use in process reporting after the upgrade.
    4. Save user details for Transcoder so these can we used after upgrade.

Step 3: Uninstall the previous version of Zoom

  1. Delete [ZoomInstallDir]/.

Step 4: Install the new version of Zoom

  1. Untar the zoom-unix64.tar.bz2 from the Zoom Support Center.
  2. Install Zoom in the previous location, [ZoomInstallDir]/.

Step 5: Update configurations

  1. Open server.xml in the [ZoomInstallDir]/conf/ folder
    • Replace 0.0.0.0 in <host>0.0.0.0</host> tag under <networkspec> and <webserverspec> with your Zoom Server IP address.
    • Replace 0.0.0.0 in <host>0.0.0.0</host> tag under <reviewserverspec> with your Preview Server IP address.
    • For Zoom 7.2 and below, replace 0.0.0.0 in <host>0.0.0.0</host> tag under <ftsspec> with your Curator Server IP address.
  2. Merge your backup server.xml with the new server.xml to retain your old settings as well as get the new tags and configuration parameters.
    From Zoom 7.3 onwards, <ftsspec> section in server.xml is called <curatorSpec>. Check Curator Configuration (Zoom 7.3+) post for Curator set up instructions.
  3. Merge your backup of metadataspec.xml in the backup conf/ folder with the one in [ZoomInstallDir]/conf/ folder.
  4. Open client-settings/ from [ZoomInstallDir]/conf/ and merge each file from the backup conf/client-settings/ folder with the new files.
    Additional changes to other files in the conf folder will also need to be synchronized manually. For example, if you had changed the value of “wrapper.java.initmemory=128” flag in your old wrapper.conf to increase the initial java heap size, then you have to manually edit/replace the value of the same flag in wrapper.conf inside the newly installed [ZoomInstallDir]/conf/ directory.
  5. Only for the Preview Server:
    • Copy the preview server cache from your backup folder to [ZoomInstallDir]/webcontext/servers/PreviewServer/cache/ (if it was backed up earlier in Step 2: Backup files).
    • Open preview-server.xml from [ZoomInstallDir]/conf/ and replace localhost with your Zoom Server IP address.
    • Merge your backup preview-server.xml with the new preview-server.xml to retain your old settings as well as get the new tags and configuration parameters.
    • Open server-settings/ from [ZoomInstallDir]/conf/ and merge each file from the backup conf/server-settings/ folder with the new files.
  6. Copy the db folder to the installation directory [ZoomInstallDir]/ (if it was backed up earlier in Step 2: Backup files).
  7. Copy the solr-db folder to the installation directory [ZoomInstallDir]/db/ (if it was backed up earlier in Step 2: Backup files).
  8. If you had backed it up earlier in Step 2: Backup files, then copy the backed up redo folder to the old location (redo folder location is in server.xml, <redoLogDir> tag under <dbspec>).
  9. If you are upgrading from 7.3 to 7.5.x, then copy the Audit logs that were saved from the old Zoom Server to the audit_curator folder inside the logs directory for your upgraded Zoom Server (log location is <logsEndPoint> tag in curator-server.xml on your upgraded Curator). Refer to Before upgrading to 7.5.x for details.
  10. Start services for Zoom (the order in which to start services is Zoom HADR, Zoom, Zoom Preview, and then Zoom Curator services).
  11. Zoom Server is now installed on this machine. Check the Zoom version at the Terminal using the command zm version.

Step 6: Add licenses

  1. Open the Web Management Console and add the new license key.
    For information on adding license key, refer to Updating Zoom License .
  2. Verify the install:
    • In the Web Management Console, check the version and license information.
    • Connect to the Zoom applications like Asset Browser, Web Asset Browser, Web Client and check versions.
    • Check if basic operations are working for the Zoom Clients, like search, rename, lock.

Curator Setup (if using)

Setup Zoom Server on the Curator machine as described above. The Curator Service is installed as part of the standard setup.

If Curator Service is not installed, it may be installed manually on the Curator machine:

Installing Curator Service

Navigate to the folder[ZoomInstallDir]/bin/.

  1. Copy curator-server_init.d.sh from [ZoomInstallDir]/bin/ to /etc/init.d/.
  2. Rename the newly copied file to curator-server
  3. Edit the curator-server file in a text editor, if required, to ensure the values of the following 2 variables match the Zoom setup:
    • ZOOM_HOME=Zoom_Installation_Directory; by default ZOOM_HOME=/home/evolphin/zoom
    • ZOOM_USER=Service_Running_User; by default ZOOM_USER=evolphin
  4. Open the Terminal and issue the following commands as the root user:
    • chkconfig --add curator-server
    • chkconfig --list
  5. Ensure that the curator-server service is listed in the output of the second command.
  6. Now the Curator service can be controlled, like other Zoom Services, with the following commands on the Linux Terminal:
    • service curator-server status (Check the status of Curator service)
    • service curator-server start (Start the Curator service)
    • service curator-server stop (Stop the Curator service)
    • service curator-server restart (Restart Curator service)
From Zoom 7.0 onwards, the Curator service has been renamed from Solr to Curator.
For more details about Curator setup and configuration, go to Curator Setup & Configuration (Zoom 6.0 – 7.2) . For setting up Curator in an HADR environment, go to Setup of Curator with HADR .

Additional setup

Additional Setup when upgrading to Zoom 7.0 and above

Here is a list of configurations for features or enhancements introduced in 7.0.

All other configuration details (like server configuration, metadata specification, and others) must be upgraded as before by merging the old and new files. 
  1. AI is available from Zoom 7.5 onwards to tag AI data in assets. These assets can be viewed with AI data in the Web Client. Learn how to set up AI in Zoom using an AI Engine from an AI Provider.
  2. German locale is available for use with Zoom Clients from Zoom 7.3.1 onwards. Check details on enabling locale on Servers and setting up locale on Zoom Clients.
  3. A new version of the third-party ingest module, VideoFX 2.0, is available from Zoom 7.3 onwards. Check here to set up VideoFX 2.0.
  4. VideoLX 3.0 is also available with Zoom 7.3. This new release of VideoLX can also integrate with a VideoFX setup. Check here to set up VideoLX 3.0. See how it compares with other releases of VideoFX and VideoLX.
  5. A new Auto-Retirement Policy is available to use with Zoom 7.3 onwards. It lets admins set up rules to automatically retire assets. Check here to set up rules for Auto-Retirement.
  6. PingID is available for integration with Zoom 7.2.3 onwards. Check here for details on integrating it with Zoom.
  7. Zoom 7.2 now supports Data Migration to ingest a large volume of data asynchronously to its repository. This is especially useful when migrating from another DAM/MAM software to Zoom. Check here for setting up and starting Data Migration.
  8. In Zoom 7.1, a new Zoom Sketch plugin allows users to access the power of the Zoom repository in the Sketch app. Check here to know the steps to install the plugin. Sketch plugin is not supported from Zoom 7.3 onwards.
  9. Zoom 7.1 is equipped to work with the latest VideoLX 2.0 using Evolphin’s own transcoder for proxy-generation. Check here to set up VideoLX 2.0.
  10. Zoom uses a new licensing model from 7.0 onwards. Check here for details.
  11. From 7.0 onwards, a new Web Client is available for easily sharing assets between Zoom users as well as external users. This Web Client is ready to use after installation. However, setup basic features like your company’s logo, asset filters, and default locations by following Web Client Branding & Configuration .
  12. Zoom Adobe Plugin has some new configuration in 7.0. Take a look at how to manipulate the templates required for New Project creation here New Project Creation in Adobe Plugin .
  13. SSL is now supported for all core Zoom commands from version 7.0 onwards. To setup SSL in Zoom, follow Enable SSL for Desktop Zoom Applications .
  14. New media converters are available from Zoom 7.0 onwards. Check here for information about adding these in Zoom.