Upgrade Semarchy xDI

This section provides the procedures to upgrade the Semarchy xDI components from previous versions:

Before the Upgrade

Review the Documentation

Before starting the upgrade, you should review the following information:

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

  • The installation instructions for installing and configuring Semarchy xDI. You should review the system requirements for this new release.

Understand Release Versions and Types

Semarchy xDI releases are identified by a version number and a release type. For example, 2023.1.0 LTS.

Version Number

Version numbers in Semarchy xDI are expressed in the following format: <major_version>.<minor_version>.<patch_version>. For example, 2023.1.0.

Starting with 2023.1, the first two numbers reflect the year and quarter of the first GA release for a given minor version. For example, xDI 2023.2 was released in the second quarter of 2023.

Patches increment the <patch_version> number. For example, patches for the initial 2023.2.0 release are numbered 2023.2.1, 2023.2.2, etc.
Although these patches occur later in time, the first GA release date for 2O23.2 remains unchanged.

Release Type

Releases also have a release type. For example, 2023.1.0 LTS.

  • The MS release type stands for Mainstream Support. MS releases occur quarterly and introduce new features. MS releases accelerate the availability of new features for customers who want access to the latest improvements and enhancements as soon as possible.

  • The LTS release type stands for Long-Term Support. LTS releases typically occur every year and consolidate features introduced by the previous MS releases. They are maintained and supported for a longer time. LTS releases provide an option more suited for slowly-changing environments, or for customers who prefer a fully supported environment for an extended time without having to apply upgrades other than patches.

The first release date and the release type define the end-of-maintenance and end-of-support for a given release.

Refer to the Global Support Policy in the Semarchy website for more details about the LTS and MS release types. This page also lists, per release, the first release, end-of-maintenance, and end-of-support dates.

Major, Minor, and Patch Upgrades

An upgrade may be a major upgrade, a minor upgrade, or a patch. The differences between the old version number and the new version number define the type of upgrade.

  • A Major Upgrade takes place as soon as the major version number differs. Major versions include major feature changes and typically require additional upgrade steps. For example, upgrading from 5.3.0 to 2023.1.0 is a major version upgrade.

  • A Minor Upgrade takes place when the major version remains the same but the minor version differs. Minor versions include minor feature changes and may require additional upgrade steps. For example, upgrading from 2023.1.0 to 2023.2.0 is a minor version upgrade.

  • A Patch is only applied when the patch version differs. Patches do not require additional upgrade steps and are easily reversible. For example, upgrading from 2023.1.0 to 2023.1.3 is patching.

Unless otherwise specified, the upgrade path between two versions of Semarchy xDI is direct. You do not need to install intermediate versions.

Component Compatibility

By default, we prioritize forward compatibility between the Semarchy xDI components (Designer, Runtime, Analytics) during our development process.

However, the following recommendations should be applied when upgrading Semarchy xDI:

  • When upgrading from one major or minor version to another, upgrade the entire stack of components to maintain consistency in versions.

  • For patch upgrades, having different patch versions is generally acceptable, unless explicitly mentioned in the components' release notes.