Upgrading Elvis 6

When upgrading an existing version of Elvis 6 (Server and client) to a newer version of Elvis 6, 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. Reviewing optional steps (before upgrading)
3. Stopping your current server
4. Installing Elvis Server
5. Configuring Elvis Server
6. Reviewing optional steps (after upgrading)
7. Starting Elvis Server
8. Testing Elvis 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 Elvis releases by reading through the Release Notes.
3. Also verify the Compatibility Matrix to see if any changes have been made to the compatibility of Elvis with other systems.

1. Creating a backup of the existing installation

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

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

• Elvis Hot Data
• Elvis Shared Data
• Config

2. Reviewing optional steps (before upgrading)

Depending on the version of Elvis that you are upgrading from or to, some additional steps may be required before the new version of Elvis Server is installed.

Review the below information and implement when necessary.

Upgrading from Elvis 6.36 – 6.39 to Elvis 6.40 or higher

• Okta. (This step is only required when using Okta as the Single Sign-On authorization provider) In Elvis 6.40, some of the configuration options for Okta have been renamed. These name changes also need to be performed manually in your current version of Elvis, else their values will be lost during the upgrade.

Step 1. Access the Management console and navigate to Server configuration > Files.

Step 2. Open the cluster-config.properties.txt file.

Step 3. Add the following property:

sso.provider = okta

Step 4. Rename the following properties:

Step 5. Click Save.

3. Stopping your current server

Stop your current Elvis Server from running.

4. Installing Elvis 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.

5. Configuring Elvis 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.

6. Reviewing optional steps (after upgrading)

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

Review the below information and implement when and where necessary.

Upgrading from Elvis 6.16 or earlier

• Elvis Agent. When using Elvis Agent (used for opening files for editing using the Pro client), the version of Elvis Agent that was installed in Elvis 6.16 or earlier needs to be replaced with the version of Elvis Agent that is shipped with Elvis 6.17 or later. This is because of security changes that have been implemented.

Upgrading to Elvis 6.18 or higher

• Enterprise integration. Elvis 6.18 is compatible with all versions of Enterprise Server 10. However, with the release of Enterprise Server 10.5.0, significant changes have been made to the way the integration is implemented. When Enterprise Server 10.5 or higher is used in combination with Elvis 6.18 therefore, follow the upgrade steps as described in Integrating Elvis 6 in Enterprise Server 10.5 or higher.

Upgrading from Elvis 6.19 to Elvis 6.20 or higher

• Enterprise integration. Elvis 6.19 introduced the Enterprise Servers page in the Management Console with which a trusted connection between Elvis Server and Enterprise Server can be set up. In Elvis 6.20 changes have been made to the working of this feature. When a client ID and password have been generated using the Enterprise Servers page of Elvis 6.19, a new client ID and password need to be generated using the Enterprise Servers page of Elvis 6.20 or higher. The configuration file also need to be updated with this new ID and password. See Integrating Elvis 6 in Enterprise Server 10.5 or higher.

Upgrading to Elvis 6.41 or higher

• Pro client: Copying and moving files. To improve the process of moving and (to a lesser extent) copying files, code changes (refactoring) around Move and Copy operations have been made in Elvis 6.41. A small chance exists that external API usages may have been overlooked. After upgrading therefore, make sure to verify that any integrations and plug-ins are working as intended. Note also that subsequent releases will contain similar refactoring actions in various operations.

Upgrading to Elvis 6.43 or higher

• Indexing. As part of the upgrade process, a re-index of the asset index is performed. It might take some time for this process to complete.

• Enterprise integration. As a result of changing the createName field to a multi-value field, the plug-in configuration in Enterprise Server may need to be adjusted. Find the configuration for 'creatorName' and set the second parameter from 'false' to 'true' to handle it correctly. See 'Standard metadata fields' in Configuring the mapping of metadata fields between Enterprise 10 and Elvis 6.

• Dialog plug-ins: padding set to zero. In Elvis version 6.42 or older, dialog plug-ins contain a padding of 30 pixels (top and bottom) by 20 pixels (left and right side). Because certain designs require a different padding or no padding at all, the default padding has been removed (no padding). For any existing Dialog plug-ins, the padding needs to be restored by adding the following code:

body {
    padding: 30px 20px;
}

7. Starting Elvis Server

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

Important: As part of the upgrade process, Elvis 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 Elvis Server until this process is finished. Use the Paramedic page of Elvis Server (access Elvis Server > Support Tools > Elasticsearch > Paramedic or use URL localhost:9200/_plugin/paramedic/) to monitor the progress.

8. Testing Elvis Server

Verify that Elvis Server is working properly by using the the Pro Client. 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.