Upgrading to i2 Analyze 4.4.4

Before you begin

Before you upgrade your production deployment, use a pre-production or test environment to verify that you can complete the upgrade process successfully and that you are familiar with the procedure. After you test the upgrade process for your deployment, complete the upgrade in your production environment. If you do not have a pre-production or test environment, you can create one. For more information, see Creating a production deployment.

• If you are upgrading a deployment of i2 Analyze at version 4.4.2 or earlier, the Solr indexing service is upgraded to version 9. After you upgrade to Solr 9, Apache recommends that you reindex your data. While the data is being reindexed the system is offline. In systems where there is a lot of data, this can take some time. During the upgrade process, you are directed to run the toolkit command that reindexes your data.

• The upgrade process clears the server's store of any unsaved web charts, Visual Queries, and import specifications that users have created. Ask your users to save any work that they want to keep before you start the upgrade.

• Ensure that you back up your deployment before you complete an upgrade. For more information about backing up your deployment, see Backing up a deployment.

About this task

Depending on the scale and complexity of your data, changes of this nature can take time. You might want to plan your upgrade to take place in a period where there is usually no activity.

As part of the i2 Analyze upgrade process, Open Liberty, Solr, ZooKeeper, and Java are updated. You do not need to download and update these prerequisites before you upgrade an existing deployment.

Procedure

To upgrade the deployment toolkit to version 4.4.4:

1. Stop i2 Analyze:

   • In a single-server topology, run setup -t stop.

   • In a multiple-server topology, see Stopping and starting i2 Analyze.

2. On each server where the deployment toolkit is installed, make a backup of the i2 Analyze directory, including the toolkit. For example, i2/i2analyze.

3. Install the i2 Analyze deployment toolkit.

   1. On each server where the toolkit is installed, remove the toolkit, license, and swidtag directories from the existing installation.

   2. Install the i2 Analyze version 4.4.4 deployment toolkit over your existing i2 Analyze directory. For more information, see Installing i2 Analyze.

4. For each deployment toolkit in your deployment, copy the configuration directory that you backed up in Step 2 to the i2analyze/toolkit directory of the upgraded deployment toolkit that you installed in Step 3.

5. If it is not already present, create and populate the credentials.properties file. This file must be stored in the location toolkit/configuration/environment in each deployment toolkit.

   For more information about the file, see The credentials.properties file.

After you upgrade the deployment toolkit, you can use it to upgrade the deployment to version 4.4.4:

1. Upgrade and start i2 Analyze according to the instructions in Upgrading an i2 Analyze deployment.

2. If you are using the IBM HTTP Server, restart it.

Important: If you're upgrading from version 4.4.3 or earlier, the upgrade process includes some automatic changes to the configuration of the deployment, to support user provisioning. The changes have two consequences:

• If you keep a backup of your configuration, take a new backup when the upgrade is complete.

• If you want to use the configuration from an i2 Analyze deployment that was upgraded to 4.4.4 in a new deployment of i2 Analyze 4.4.4, you must edit it first. Specifically, you need to delete (or set to false) the two "Compatibility" settings in the ApolloServerSettingsMandatory.properties file.

What to do next

If your deployment includes the ETL toolkit, you must upgrade the ETL toolkit to version 4.4.4 after you upgrade the rest of the deployment. For more information, see Upgrading the ETL toolkit.

After you upgrade, you might need to update the configuration of your deployment for any new or modified configuration settings. For more information about new and modified configuration settings, see Configuration and database changes.

When you start the server after you upgrade, extra processing of the data in the Information Store is completed after the upgrade. During this processing, you might not be able to ingest, update, and delete data in the Information Store. For more information, see Information Store processing after you upgrade i2 Analyze.