Updating the Backend/IA Agent

This section guides you through the steps required to update your Analytics installation.

Important! The following upgrade packages can be downloaded from Automic downloads page and from our marketplace on https://marketplace.automic.com/

This page includes the following:

Note: If you are upgrading from Automic System v12.2 ( Analytics v1.0.3) to v12.3 ( Analytics v2.3) and would like to install the Streaming Platform and the Event Engine, see the manual installation document for each individual component.

For further information on the Event Engine installation, see: Setting up the Rule Engine and Setting up the Rule Engine on Linux

For further information on the Streaming Platform installation, see: Setting up the Streaming Platform and Setting up the Streaming Platform on Linux

Mapping versions of Analytics Backend and Automic Automation

The following section outlines the mapping between the Analytics Backend component and Automic Automation:

Mapping versions of Analytics Backend and Automic Automation

The following section outlines the mapping between the Analytics Backend component and Automic Automation:

Backend Version Automic Automation Version
1.0.x 12.0
2.0.x 12.1.0
2.1.x 12.1.1+
2.2.x 12.2
2.3 12.3

To Update an Existing Analytics Backend/IA Agent Installation from v2.2.x to v2.3.0

  1. Read the release notes and check if the properties files require any change.
  2. Update the Analytics Backend/IA Agent:

    1. Stop the Backend/IA Agent
    2. Upgrade the AE from v12.2 to v12.3
    3. Replace the 2.2.x Analytics Backend jar file with the 2.3.0 jar file
    4. Start the Backend/IA Agent

      • Analytics Backend will start up and run as part of the IA Agent
      • Analytics Datastore is migrated to the new schema. The migration can take some time, depending on the amount of data migrated.
      • Agent will establish the connection to the AE mentioned in the INI file.

    5. Upgrade AWI from v12.2 to v12.3

    6. Install new Analytics UI Plug-in (and Rules UI Plug-in if needed)

    • Extract the webui-plugin-analytics.jar from the download package.
    • Copy the webui-plugin-analytics.jar to the AWI_ROOT_FOLDER/WEBINF/autoinstall folder.

    Important!

    • The existing webui-plugin-analytics.jar file must be removed before copying the new one.
    • If required, update the configuration in AWI_ROOT_FOLDER/config/awi-plugins-reporting/reporting.properties.

To Update an Existing Analytics Backend/IA Agent Installation from v2.1.x to v2.3.0

  1. Read the release notes and check if the properties files require any change.
  2. Update the Analytics Backend/IA Agent:

    1. Stop the Backend/IA Agent
    2. Upgrade the AE from v12.1 to v12.3
    3. Replace the 2.1.x Analytics Backend jar file with the 2.3.0 jar file
    4. Start the Backend/IA Agent

      • Analytics Backend will start up and run as part of the IA Agent
      • Analytics Datastore is migrated to the new schema. The migration can take some time, depending on the amount of data migrated.
      • Agent will establish the connection to the AE mentioned in the INI file.

    5. Upgrade AWI from v12.1 to v12.3

    6. Install new Analytics UI Plug-in (and Rules UI Plug-in if needed)

    • Extract the webui-plugin-analytics.jar from the download package.
    • Copy the webui-plugin-analytics.jar to the AWI_ROOT_FOLDER/WEBINF/autoinstall folder.

    Important!

    • The existing webui-plugin-analytics.jar file must be removed before copying the new one.
    • If required, update the configuration in AWI_ROOT_FOLDER/config/awi-plugins-reporting/reporting.properties.

To Update an Existing Analytics Backend/IA Agent Installation from v2.0.0 to v2.3.0

  1. Read the release notes and check if the properties files require any change.
  2. Update the Analytics Backend/IA Agent:

    1. Stop the Backend/IA Agent
    2. Upgrade the AE from v12.1.0 to v12.3
    3. Replace the 2.0.0 Analytics Backend jar file with the 2.3.0 jar file
    4. Start the Backend/IA Agent

      • Analytics Backend will start up and run as part of the IA Agent
      • Analytics Datastore is migrated to the new schema. The migration can take some time, depending on the amount of data migrated.
      • Agent will establish the connection to the AE mentioned in the INI file.

    5. Upgrade AWI from v12.1.0 to v12.3

    6. Install new Analytics UI Plug-in (and Rules UI Plug-in if needed)

    • Extract the webui-plugin-analytics.jar from the download package.
    • Copy the webui-plugin-analytics.jar to the AWI_ROOT_FOLDER/WEBINF/autoinstall folder.

    Important!

    • The existing webui-plugin-analytics.jar file must be removed before copying the new one.
    • If required, update the configuration in AWI_ROOT_FOLDER/config/awi-plugins-reporting/reporting.properties.

To Update an Existing Analytics Backend/IA Agent Installation from v1.0.4 to v2.3.0

  1. Download the package, read the release notes, and check if any changes are required in the properties file.
  2. Update the Analytics Backend/IA Agent:

    Important!

    If you are using Analytics Backend v1.0.3 and want to update to v2.3.0, you must first update to v1.0.4.

    1. Stop the Backend and AWI
    2. Back-up the folder: <AUTOMIC HOME>/Automation.Platform/Analytics/backend
    3. Back-up your Analytics PostgreSQL Datastore
    4. Upgrade the AE from v12.0 to v12.3
    5. Copy all the files from <ISO_AWA or CDA_12.3.0>/Automation.Platform/Analytics/backend to <AUTOMIC_HOME>/Automation.Platform/Analytics/backend
    6. Copy the application.properties.sample file and rename it to application.properties
    7. In the file application.properties, restore the key parameters needed from the backup (JDBC connections parameters)

      Example:

      • Analytics: datasource.analytics.url, datasource.analytics.username, datasource.analytics.password
      • AE: datasource.ae.url, datasource.ae.username, datasource.ae.password
      • CDA: datasource.ara[100].url, datasource.ara[100].username, datasource.ara[100].password

    8. Optional. In the application.properties file, customize the parameters to activate or de-activate Flink or Kafka component parameters.

      • Rule Engine: collector.events.enabled, flink.host, kafka.bootstrap_servers, zookeeper.bootstrap_servers

    9. Start the Backend/IA Agent

    10. Copy all the files from <ISO_AWA or CDA_12.3.0>/Automation.Platform/Analytics/ui-plugin to <AUTOMIC_HOME>/External.Resources/apache-tomcat-xxx/webapps/awi/WEB-INF/autoinstall

      • Analytics Backend will start-up and run as part of the IA Agent
      • Analytics Datastore is migrated to the new schema. The migration can take some time, depending on the amount of data migrated.
      • Agent will establish the connection to the AE mentioned in the INI file

    11. Upgrade AWI from 12.0 to 12.3
    12. Install new Analytics UI Plug-in (and Rules UI Plug-in if needed)

      • Extract all the webui-plugin-analytics.jar from the downloaded package.
      • Copy the webui-plugin-analytics.jar to the AWI_ROOT_FOLDER/WEBINF/autoinstall folder.
      • Download and install the Action Pack PCK.AUTOMIC_ANALYTICS 1.0.5 from here

    Important!

    • The existing webui-plugin-analytics.jar file must be removed before copying the new one.
    • If required, update the configuration in AWI_ROOT_FOLDER/config/awi-plugins-reporting/reporting.properties.

To Update an Existing Analytics Installation from v1.0.3 to v1.0.4

Important! Direct update from v1.0.3 to v2.3.0 is not possible. This issue is related to the migration of the PostgreSQL database schema. Do not update directly to v2.3.0 from v1.0.3, this will cause the backend to fail and show the following log message:

Error Message shown with direct update is made from ANOP v1.0.3 to v2.3.0

  1. Download ANOP v1.0.4 from the Automic Downloads page as part of the Automic Automation or CDA package. Alternatively you can download the update directly from the Component Downloads page. Read the release notes and check if the properties files require any change.
  2. Update the Analytics Backend:

    1. Stop the Backend
    2. Back-up the folder: <AUTOMIC HOME>/Automation.Platform/Analytics/backend
    3. Back-up Analytics PostgreSQL Datastore
    4. Replace the v1.0.3 Analytics Backend jar file with the v1.0.4 jar file
    5. Copy the applications.properties.sample file and rename it to application.properties
    6. Restore the JDBC connections parameters stored in Back-up applications.properties file

      Example:

      Analytics: datasource.analytics.url, datasource.analytics.username, datasource.analytics.password

      AE: datasource.ae.url, datasource.ae.username, datasource.ae.password

      CDA: datasource.ara[100].url, datasource.ara[100].username, datasource.ara[100].password

    7. Install new Analytics UI Plug-in
      • Extract the webui-plugin-analytics.jar from the download package.
      • Copy the webui-plugin-analytics.jar to the AWI_ROOT_FOLDER/WEBINF/autoinstall folder.
    8. Start the Backend
    9. If your migration is successful the following message will appear in your log file:

      Successful upgrade to ANOP 1.0.4

    Important!

    • The existing webui-plugin-analytics.jar file must be removed before copying the new one.
    • If required, update the configuration in AWI_ROOT_FOLDER/config/awi-plugins-reporting/reporting.properties.