Upgrade Semarchy xDM

This document is an overview of the procedure for upgrading the Semarchy xDM platform from previous versions.

Before the Upgrade

Review the Documentation

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

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

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

  • Review the major changes that may impact your upgrade, as well as the required actions listed in Pre-Upgrade Actions. Make sure to review these before starting the upgrade process.

  • Depending on your current version and the upgrade version, some actions may be required after the upgrade process. Review the Post-Upgrade Actions before starting the upgrade process.

Understand Major, Minor and Patch Versions

Version numbers in Semarchy xDM are expressed in the following format: <major_version>.<minor_version>.<patch_version>. For example, version 5.1.5.

The 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 differs. Major versions include major feature changes, and typically require repository and data locations upgrade. For example, upgrading from 4.4.3 to 5.3.0 or from 5.3.18 to 2023.1.0 is a major version upgrade.

  • A Minor Upgrade takes place when first digit remains the same but the second differs. Minor versions include minor feature changes, and typically require repository and data locations upgrade. For example, upgrading from 5.0.3 to 5.1.0 is a minor version upgrade.

  • A Patch is only applied when the patch version differs. Patches do not require repository and data location upgrade. For example, upgrading from 5.1.0 to 5.1.5 is patching.

Although the process is the same for all types of upgrade, be aware that the repository and data location upgrade steps may be skipped for patches.

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

Select the Upgrade Path

The upgrade supports two paths:

  • In-Place Upgrade consists in installing the new version of Semarchy 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.

  • Out-of-Place Upgrade consists in replicating the existing Semarchy xDM environment and upgrading the copy. The original environment remains unchanged.

You may choose one of the two paths depending on your IT infrastructure policies for upgrading.

In-Place Upgrade

The in-place upgrade path is as follows:

  1. Review and perform the Pre-Upgrade Actions.

  2. Stop All Server Instances and Connections.

  3. Backup Your Installation.

  4. Install the New Server Version.

  5. Configure the New Server.

  6. Start One New Server Instance.

  7. Upgrade the Repository.

  8. Upgrade the Data Locations.

  9. Restart All Server Instances.

  10. Perform the Post-Upgrade Actions.

Out-of-Place Upgrade

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

  1. Review and perform the Pre-Upgrade Actions.

  2. Stop All Server Instances and Connections.

  3. Backup Your Installation.

  4. Duplicate your Database Schemas.

  5. Install the New Server Version.

  6. Configure the New Server.

  7. Start One New Server Instance.

  8. Upgrade the Repository.

  9. Upgrade the Data Locations.

  10. Restart All Server Instances.

  11. Perform the Post-Upgrade Actions.