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: <year>.<quarter>.<patch_version>. For example, 2023.1.0.

The first two numbers reflect the year and quarter of the first General Availability (GA) release for a given version. For example, xDI 2023.2 was released in the second quarter of the year 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 on 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 and patch upgrades

An upgrade may be a major upgrade or a patch depending on the difference between the new and old version numbers.

  • An upgrade is a major upgrade if the year or quarter numbers are different. There may be feature changes that require additional upgrade steps. For example, upgrading from 5.3.0 to 2023.1.0, or 2023.2.0 to 2023.3.0 is a major upgrade.

  • An upgrade is a patch if only the patch version is different. Patches usually do not require additional upgrade steps and are easily reversible. For example, upgrading from 2023.1.0 to 2023.1.3 is a patch upgrade.

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

Component compatibility

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

However, we recommend to keep the following things in mind when upgrading Semarchy xDI:

  • When upgrading from one major version to another, upgrade the entire component stack to maintain version consistency.

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