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:

  • To stay informed about new features, bug fixes, and more, see the latest release notes.

  • Familiarize yourself with the installation instructions and system requirements for Semarchy xDI.

  • Depending on your current version, certain actions may be required after the upgrade. Make sure to review the post-upgrade actions for each component before starting the upgrade process.

Understand release versions and types

Semarchy xDI releases are identified by a version number and a release type, such as 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:

  • 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.

  • 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.

For additional information regarding LTS and MS release types, see our Global support policy on the Semarchy website. This page also lists release dates and support timelines for each release.

Major, minor, and patch upgrades

Upgrades may be categorized as major, minor, or patch, depending on the changes in the version number.

  • A major upgrade is indicated by a change in the major version number. Major upgrades involve significant feature changes and typically require repository and data location upgrades. For example, upgrading from 5.3.0 to 2023.1.0 represents a major upgrade.

  • A minor upgrade is indicated by a change in the minor version number, while the major version number remains the same. Minor upgrades include smaller feature changes and typically require repository and data location upgrades. For example, upgrading from 2023.1.0 to 2023.2.0 represents a minor upgrade.

  • A patch is indicated by a change in the patch version number only. A few exceptions aside, patches do not require repository and data location upgrades and are easily reversible. For example, upgrading from 2023.1.0 to 2023.1.3 represents a patch upgrade.

Unless otherwise specified, the upgrade path from one version of Semarchy xDI to another is direct. You do not need to install intermediate versions.

Component compatibility

Semarchy xDI prioritizes forward compatibility between Semarchy xDI components (Designer, Runtime, Analytics). However, you should 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 components at different patch versions is generally acceptable, unless explicitly mentioned in the components' release notes.