Upgrading the Analytics Backend/IA Agent

As an administrator you upgrade your Analytics installation. This topic describes how to upgrade Analytics manually in an on-premises Automic Automation system. This topic does not apply for Automic Automation Kubernetes Edition (AAKE) systems. If you are migrating Automic Automation from an earlier version to an AAKE system, see Container-Based System Upgrade - Automic Automation Kubernetes Edition.

Important!

• The relevant upgrade packages can be downloaded from Automic downloads page and from our marketplace at https://marketplace.automic.com/

• Make sure you fulfill the requirements for the TLS/SSL configuration of the Automation Engine before upgrading it. Also, since AWI connects to the JCP, make sure you have all the relevant certificates in place. For more information, see Securing Connections to the AE (TLS/SSL) and TLS/SSL Certificate Considerations.

• As of version 24, Automic Automation supports Unicode / UTF-8. Analytics supports only PostgreSQL databases. If your Analytics database already supports UTF-8 as recommended in previous versions, there is no need to change its configuration. For more information, see Universal Language Support (Unicode).

Mapping Versions of Analytics Backend and Automic Automation

Below you find the version mapping between the Analytics Backend component and Automic Automation. Make sure that the Analytics Backend uses at least the same major and minor version as the Automation Engine and the Automic Web Interface:

• Backend 2.3.x = 12.3.x Automic Automation

• Backend 21.0.0 = 21.0.x Automic Automation

• Backend 24.0.0 = 24.x Automic Automation

Upgrading the Analytics Backend/IA Agent from v21.0.0 to v24.0.0

The relevant Analytics upgrade packages can be downloaded from Automic downloads page and from our marketplace at https://marketplace.automic.com/.

Make sure you read the release notes and check if the properties files require any change before upgrading the Analytics Backend/IA Agent. To do so, follow these steps:

1. Stop the Backend/IA Agent.

2. Upgrade the AE from v21.0.x to v24.x. Make sure you fulfill all TLS/SSL requirements and have the necessary certificates in place.

3. Replace the 21.0.0Analytics Backend jar file with the 24.0.0 jar file.

4. Adapt the INI file of the Backend/IA Agent to connect to port of the new Java communication process (JCP).

   Note: Also, make sure you check the AE database connection in the application.properties file to ensure the new UTF-8 AE database can be reached.

5. Start the Backend/IA Agent.

   The Analytics Backend starts up and runs as part of the IA Agent. The Analytics Datastore is migrated to the new schema, which can take some time, depending on the amount of data migrated. The Agent establishes the connection to the AE mentioned in the INI file.

6. Upgrade AWI from v21.0.x to v24.x. Since the new version of AWI connects to the new Java communication process (JCP), make sure you fulfill all TLS/SSL requirements and have the necessary certificates in place.

7. The Analytics WebUI plugin is part of the AWI standard installation and is available in its autoinstallation folder. Update the plugin.properties file to enable the communication between the plugin and the backend over the REST API as follows:

   • backend.api_key=

     This key secures access to the backend REST API. It was generated by the setup.psql script when you set up the datastore. When setting up the datastore, you copied this key to a text file.

   • backend.endpoint=

     This is the hostname of the Analytics Backend host

Upgrading the Analytics Backend/IA Agent from v2.3.x to v24.0.0

The relevant Analytics upgrade packages can be downloaded from Automic downloads page and from our marketplace at https://marketplace.automic.com/.

Make sure you read the release notes and check if the properties files require any change before upgrading the Analytics Backend/IA Agent. To do so, follow these steps:

1. Stop the Backend/IA Agent.

2. Upgrade the AE from v12.3 to v24.x. Make sure you fulfill all TLS/SSL requirements and have the necessary certificates in place.

3. Replace the 2.3.xAnalytics Backend jar file with the 24.0.0 jar file.

4. Adapt the INI file of the Backend/IA Agent to connect to port of the new Java communication process (JCP).

   Note: Also, make sure you check the AE database connection in the application.properties file to ensure the new UTF-8 AE database can be reached.

5. Start the Backend/IA Agent.

   (missing or bad snippet)

6. Upgrade AWI from v12.3 to v24.x. Since the new version of AWI connects to the new Java communication process (JCP), make sure you fulfill all TLS/SSL requirements and have the necessary certificates in place.

7. The Analytics WebUI plugin is part of the AWI standard installation and is available in its autoinstallation folder. Update the plugin.properties file to enable the communication between the plugin and the backend over the REST API as follows:

   • backend.api_key=

     This key secures access to the backend REST API. It was generated by the setup.psql script when you set up the datastore. When setting up the datastore, you copied this key to a text file.

   • backend.endpoint=

     This is the hostname of the Analytics Backend host