Upgrade Semarchy xDI Production Analytics

This document provides instructions to upgrade Semarchy xDI Production Analytics.

Pre-Upgrade Steps

This section describes the operations to perform before upgrading Semarchy xDI Production Analytics.

Review The Release Notes

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

System Requirements

Review the system requirements for this release.

Semarchy xDI Production Analytics 2023.1.x requires a JDK 11.0.2 or higher. If you are using an older version, upgrade to Java 11.0.2 or above. The supported Java versions are listed in the system requirements.

Backup Semarchy xDI Production Analytics

Before upgrading Semarchy xDI Production Analytics, it is recommended to perform a backup of your current installation, including:

  • The Semarchy xDI Production Analytics database.

  • The Semarchy xDI Production Analytics webapp home directory.

  • The Semarchy xDI Production Analytics Web Application Archive (.war file) and its configuration.

Upgrade Steps

To upgrade Semarchy xDI Production Analytics:

  1. Download the latest version of Semarchy xDI Production Analytics from the Semarchy website. It is shipped as an archive file, containing a Web Application Archive.

  2. Undeploy the previous version of Analytics from your application server.

  3. Configure Analytics’s home application folder as detailed in the installation guide.

  4. Deploy the new Semarchy xDI Production Analytics web application.

Connect to Analytics

When the deployment is complete, you can access the Semarchy xDI Production Analytics application at the following URL. This URL may vary depending on the application server configuration:

http://<host>:<port>/semarchy-xdi-analytics/semarchy

Post-Upgrade Steps

Depending on the version of Semarchy xDI from which you upgrade, you need to perform actions after the upgrade procedure.

The actions are listed incrementally, please read all the sub-sections in this document until you reach your current Semarchy xDI product version. If no action is indicated in this document for your versions, then no specific action is required.

For example, when upgrading from 2.x to 2023.1.x, install version 2023.1.x and follow the upgrade steps of 3.x, 5.3.x in addition to those of 2023.1.x.

Upgrading from Versions Before 2023.1.0

If you are upgrading from a version before 2023.1.0:

  • Update Runtimes Configuration

    • Open the Administration and go to the Runtime tab.

    • For each Runtime configured in Analytics, define the protocol in the Host field when it is undefined, as it is now mandatory. For example, change localhost to http://localhost. See Configure Runtimes for more details.

  • Install the H2 JDBC Driver

    • This driver is no longer shipped with Semarchy xDI Production Analytics and must be copied to the Semarchy xDI Production Analytics webapp home. See Configure Log Databases for details.

      Adding the driver if you are using Log Databases stored in H2 databases, which is Runtime’s default.

Upgrading from Versions Before 3.x

If you are upgrading from a version before 3.x, follow the upgrade steps of all the major intermediate versions between your version and 2023.1.x.