When upgrading from an earlier version of Elvis to Elvis 4 or when upgrading an existing version of Elvis 4 to a newer version of Elvis 4, check the instructions below for any additional steps to perform on top of the regular installation steps.
See also:
Important: Before upgrading a production environment, make sure you have a recent backup of your Config and Elvis Data, including a backup of the Elvis Data folder.
Automatic steps
- Automatic usage log migration. This may take a few hours.
- After the usage log migration, an automatic index updater will run to extract more metadata and rebuild auto-created relations.
This may take several days, depending on the amount of assets, just let it run in the background.
Manual steps
Step 1. Migrate scheduled plug-ins to new plug-in framework (see Migrate modules to plug-ins).
Step 2. Install new clients from the install page if automatic client upgrade is broken.
Automatic steps
- An automatic index updater will run to extract more metadata.
This may take several days, depending on the amount of assets, just let it run in the background.
Manual steps
None.
Automatic steps
- An automatic index updater will run to extract more metadata.
This may take several days, depending on the amount of assets, just let it run in the background.
Manual steps
None.
Automatic steps
None.
Manual steps
None.
Automatic steps
None.
Manual steps
Step 1. Migrate the processing cluster configuration. Set mainServerUrl on processing servers if needed, see clean-example-config. The config settings useRemoteProcessing and allowedHosts are no longer used.
Step 2. Make sure you configure the correct 'locale' in the config, see clean-example-config. Then start the server and manually configure the index updater to re-index existing metadata:
Step 2a. Make sure to deselect all index updater options, re-extracting metadata is not needed.
Step 2b. Increase index revision and start.
Step 3. Re-install desktop clients from the install page; the automatic client upgrade is broken.
Automatic steps
None.
Manual steps
Step 1.Activate the server using your new serial. The 'license.lic' file is no longer used.
Step 2.Assign new capabilities to existing user groups.
- When you have activated multiple types of user licenses you must set up user license type capabilities. This is needed so Elvis knows what kind of license to use for which groups of users.
- Several features now have to be assigned through capabilities: saved searches, favorites, collections, plug-ins. If you don't assign them, users will no longer have access to use these features.
- Assign 'Web client' and 'Download As' to users that you want to give access to the new 4.2 features.
Automatic steps
None.
Manual steps
- When using the Elvis InDesign client, make sure you run the index updater, with the following options enabled:
- Re-embed metadata into files
This is required to embed the Elvis Asset ID into the XMP metadata of the asset and is needed for auto resolving assets on layouts and the 'Edit original' flow. This may take a few hours, depending on the amount of assets. This also means that current InDesign layouts in Elvis will not resolve automatically when checked out and opened in InDesign. These need to be checked out manually and the placed assets require manually relinking to the correct assets in Elvis. For now there is no upgrade path from Adobe Drive to the new InDesign client.
- When using the Enterprise integration, make sure you run the Enterprise updater to update any out of date Enterprise objects related to Elvis assets.
Automatic steps
- Automatic split of share role in the security database. This grants each user which had the email role assigned with all share roles added in this version.
Manual steps
When you have ROLE_EMAIL assigned to an user in internal-user.properties.txt, replace it with ROLE_SHARE, ROLE_SHARE_APPROVE, ROLE_SHARE_UPLOAD.
Automatic steps
None.
Manual steps
Uninstall and reinstall the Desktop clients. (This is because of an update to the certificate of the Desktop client.)
Server
To upgrade your Elvis Server, run the server installer. It will automatically detect the existing version and will offer to upgrade. The upgrade will replace all application files. Your data, configuration and log files will not be touched.
On upgrade, the installer will create a clean-example-config-x.x.x folder with a clean copy of the latest configuration files. These can be used as reference for any new configuration options that are available.
Desktop clients
Note: Upgrading desktop clients from version 4.0.x or lower to 4.1 and higher is not possible using the desktop client upgrade dialog. Use the client install page on the server instead.
Desktop clients automatically detect new server versions and will offer to update. Alternatively users can go to the client install page on the server, which will also detect the newer client version and will allow upgrading.
If error occurs during installation, see Known issues - client install.
Elvis Drive
Important: When using the Elvis Drive client and upgrading to Elvis 4.6: please read the manual upgrade instructions in the table below carefully before upgrading to Elvis 4.6.
When the Elvis Drive connector is out of date the client will not be able to connect to the server. To upgrade the Elvis Drive connector, follow the steps on the client install page.
Special cases
Migrate modules to plug-ins
If your are upgrading from a version below 2.6 you have to manually migrate the scheduled modules to the plug-in framework. All old scheduled modules need to be migrated to schedule plug-ins with a few manual steps. For all the standard modules like the folder-import, a corresponding sample plug-in is available in the plug-ins folder.
To upgrade, perform the following steps for each module:
- Find the corresponding plug-in in the <Elvis Config>/plugins/samples/schedule_plug-ins folder, this is only available after the server has been started at least once.
- Copy the plug-in to the <Elvis Config>/plugins/active folder
- Open schedule.config.xml and migrate your settings from the old scheduled module
- Reload the plug-ins in the Elvis client (no server restart required)
- If you are using the html_public or html_user folders, migrate them by creating a plug-in for them with a webaccess.config.xml file.
Comments
0 comments
Please sign in to leave a comment.