Upgrade the License Server

This document provides instructions to upgrade the Semarchy xDI License Server.

Pre-Upgrade Steps

This section describes the operations to perform before upgrading Semarchy xDI License Server.

Review the Release Notes

The Release Notes provides the latest information about the Semarchy xDI Release, including new features, bug fixes, and breaking changes.

System Requirements

Review the system requirements for this release.

Semarchy xDI License Server 2023.3 and above requires a JDK 17. If you are using an older version, upgrade to JDK 17. The supported Java versions are listed in the system requirements.

Stop the License Server

Stop the current installation of the License Server. If it is run as a service, make sure the service does not restart automatically.

Prepare the spring-context.xml File

The License Server uses the spring-context.xml file under the ./conf folder to provide specific configurations. You must configure the new file and adapt it to your previous configuration (See Configure the License Server).

The spring-context.xml file is mandatory since version 5.3.6. If you upgrade from a previous version that did not require this file, make sure to configure it while upgrading. See Configure the License Server

If you upgrade from a License Server 1.x release to the License Server 2023.1, you must modify the content of the previous spring-context.xml to follow the renaming of plugins:

  1. Create a local copy of the spring-context.xml.

  2. Replace all occurrences of com.stambia.licence with com.semarchy.licence.server in this file.

  3. Use the modified file for the new installation.

Get a Compatible License File

If you upgrade from version 1.x or 5.x to version 2023.1 and above, you need a new license file.

Contact the Semarchy support or your account representative to obtain a new license file to deploy in your license server.

Get a Compatible License Key

The License Server 2023.1 can serve licenses for:

  • Semarchy xDI Designer version 2023.1.x

  • Semarchy xDI Designer versions 5.3.x

  • Semarchy xDI Designer versions before 5.3

The license key to configure for Semarchy xDI Designer depends on the Designer version. Make sure to provide Designer users with license keys corresponding to their product version.

Contact the Semarchy support or your account representative to obtain licenses corresponding to your product version.

Upgrade Steps

Perform the following operations to download and install the new version of Semarchy xDI License Server:

  1. Download the new version of Semarchy xDI License Server from the Semarchy website.

  2. Uncompress the downloaded file and move the archive content to the target installation folder, which must be different from the previous version’s installation folder.

  3. Configure the spring-context.xml file and adapt it to your previous configuration (see Prepare the spring-context.xml File).

  4. Copy the license file to the new installation folder.

  5. Start the License Server: refer to Start the License Server or, if the server is run as a service, refer to License Server as a Service.

Post-Upgrade Steps

Once you have verified the License Server is running properly and is successfully accessed by the Designer, perform the following operations:

  1. Remove the previous installation folder.

  2. Remove the service running the previous version of the License Server (if applicable).