Upgrade Semarchy xDM

This page provides a summary of the process for upgrading the xDM platform from earlier versions.

Before the upgrade

Before starting the upgrade, consider the following:

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 xDM.
Understand any major changes that could affect your upgrade, and make sure to review the pre-upgrade actions before starting the upgrade process.
Depending on your current version, certain actions may be required after the upgrade. Make sure to review the post-upgrade actions before starting the upgrade process.

Version numbering in Semarchy xDM is expressed in the following format: <major_version>.<minor_version>.<patch_version> (e.g., 5.1.5).

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.

Although the process is the same for all upgrade types, repository and data location upgrade steps can generally be skipped for patches.

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

The upgrade supports two paths:

An in-place upgrade consists in installing the new version of xDM in place of the previous version and upgrading the existing repositories. With this method, you can revert the environment to its original state by restoring the backup of the server folders and database schemas.
An out-of-place upgrade consists in replicating the existing xDM environment and upgrading the copy. The original environment remains unchanged.

You may choose one of the other paths for your infrastructure. This choice depends on your IT infrastructure policies for upgrading.

The in-place upgrade path is as follows:

The out-of-place upgrade path is as follows: