Upgrading Assets Server

When upgrading an existing version of Assets Server (server and client) to a newer version of Assets Server, the server and client application is upgraded while your data, server configuration and log files are left in place.

The process of upgrading is as follows:

1. Creating a backup of the existing installation
2. Stopping your current server
3. Installing Assets Server
4. Configuring Assets Server
5. Reviewing optional steps (after upgrading)
6. Starting Assets Server
7. Testing Assets Server

Before you start

Before you start the upgrading process, please do the following:

1. Read this article in full so that you are fully aware of the steps that need to be followed and the order in which they need to be performed.
2. Familiarize yourself with the changes that were made in the various releases by reading through the Release Notes for Assets Server and the Release Notes for Assets.

1. Creating a backup of the existing installation

Make sure you have a recent backup of your current environment.

Because all data is stored on the file system, all data in the following Assets Server folder locations should be backed up:

• Elvis Hot Data
• Elvis Shared Data
• Config

2. Stopping your current server

Stop your current Assets Server from running.

3. Installing Assets Server

Download the installer from the software download page, run it and follow this instructions on screen. It will automatically detect the existing version and will replace all application files. Your data, configuration and log files will not be touched.

4. Configuring Assets Server

During the Server installation, a folder named clean-example-config-x.x.x is created in the main Config folder. It contains a clean copy of the latest configuration files.

Use it as a reference for any new configuration options that are available which you might want to make use of.

5. Reviewing optional steps (after upgrading)

Depending on the version of Assets Server that you are upgrading from or to, some additional steps may have to be manually performed after Assets Server has been installed.

Review the below information and implement where applicable.

Upgrading to Assets Server 6.57 or higher

• Integration with Studio Server or Enterprise Server. The metadata selector field group 'Enterprise' has been renamed to 'Studio'. When the 'Enterprise' group is used in the custom-assetinfo.xml file, manually change this to 'Studio'.

Upgrading to Assets Server 6.63 or higher

• Permissions. From Assets Server 6.63 onwards, Rules are now created separately for files, Collections, and folders. For details, see Controlling user access to folders and files in Assets Server.

One of the most noticeable changes is that Rename, Move, and Delete permissions do not apply to the selected folder, but only to the sub folders.

When upgrading from a previous release, existing Rules are automatically split into these separate rules. Each Rule covers part of the Rule that existed previously.

After the upgrade, the permissions closely mimic the previous permission setup, thereby easing the transition for users to the new permission system.

Verify the generated Rules, and tweak or remove them to match the user requirements.

Upgrading to Assets Server 6.64 or higher

• Multi-tiered storage. A fix has been put in place whereby the storage engine pattern is now case-insensitive, as originally designed.

In previous versions, this issue resulted in files ending up in the default file storage folder instead of in the configured folder.

Should any files exist in the default folder instead of in the configured folder, correct this by running the following tool in the Management Console:

Tools > Manual upgrades > Recover misplaced asset files

6. Starting Assets Server

At this point, Assets Server is ready to be started.

Important: As part of the upgrade process, Assets Server will automatically update the index. Depending on the size of the index, this can either take a few moments or it can take some time. Do not restart Assets Server until this process is finished. Use the Paramedic page of Assets Server (access Assets Server > Support Tools > Elasticsearch > Paramedic or use URL localhost:9200/_plugin/paramedic/) to monitor the progress.

7. Testing Assets Server

Verify that Assets Server is working properly by using Assets. Perform tasks such as uploading some files, searching for them, downloading or sharing them, or any other tasks that are part of your daily workflow.

Revisions

• 22 April 2021: Updated section '5. Reviewing optional steps (after upgrading)' with steps for Assets Server 6.64.
• 30 March 2021: Updated section '5. Reviewing optional steps (after upgrading)' with steps for Assets Server 6.63.