logoBack to home screen

Updating Conversion

Conversion update is essentially a fresh installation from the provided package. You can, however, re-use certain components from the previous installation to speed up the process. Follow this tutorial if you already have Conversion and you want to install a newer version.

Prerequisites

Before updating, it is always recommended to create a full backup of all the business data (databases, file systems). If an update fails, it might be necessary to restore the system database, in addition to restoring the previous Conversion installation.

Before You Install

  1. Shut down the current Conversion installation (if running).

    • Execute ./catalina stop from /runtime/host/bin if Conversion was started from the command line with ./catalina run.
    • Execute /etc/init.d/service_name stop if Conversion was started as a Linux service.
  2. As a pre-emptive measure, back up the current Conversion installation.

  3. Unzip your new archive into your current installation root (that is, the directory containing conversion-deployment-package). conversion-deployment-package is now updated. You should have the following directories and files in the root folder (use ll to list them):

    • additional-libraries/ - created during first installation, hosts database drivers
    • conversion-deployment-package/ - your new Conversion package
    • conversion-resources/ - resources created by the previous Conversion instance. Will be overwritten when you run the new package.
    • installation-settings.yaml - installation settings created during the first installation. Update this file if the new release intruduces configuration changes.
    • license/ - created during first installation, hosts the license file.
    • logs/ - log files from the previous Conversion instance. Will be overwritten when you run the new package.
    • temp/ - temporary data from the previous Conversion instance, will be overwritten when you run the new package.
  4. If the Release Notes of your new package mention any configuration changes, adapt the installation file accordingly. If your database or file system configuration has changed, we recommend to install Conversion from scratch instead of re-using the components.

    To create new installation file based on the latest template, run cp conversion-deployment-package/example-installation-settings.yaml installation-settings.yaml. If you do that, you need to re-enter configuration data into the new file.

  5. You are now ready to install the update. Please keep in mind that if you install in the same directory as the previous installation, all temporary data (logs, elastic search data, temporary files) will be overridden when you launch the new runtime. Please continue from here as explained in Installation.

Installation

Congratulations, you are now ready to install Conversion!

  1. Go to the directory where you unzipped the package. Open conversion-deployment-package.

  2. Open the terminal and run ./install.sh. If your installation settings file is not in the default location, adapt the paths and/or names accordingly (for example /install.sh --settings /path/to/installation-settings.yaml --environment /path/to/environment.sh.

    If the installation failed, quote the full version of the package (including the -p suffix if it's in your package name) to the support team.

  3. Conversion should now be installed in the directory specified in the configuration file.

What's next?

To start the service, enter /runtime/host/bin in the installation directory, then execute ./catalina.sh run. Alternatively, you can start the server as a Linux service.

After start-up, Conversion service will be available in your browser under the host and port you configured (for example http://localhost:8080). You can also run a number of health checks to make sure everything is running smoothly. For more information, see Running Conversion and Platform Health Checks. For checks on legacy features, see Running Deep Health Checks on Legacy Endpoints.

Having updated the Conversion service, you can now do the same for ADx. See Updating ADx for details.