Upgrading AX Server

You can use the AX Server installer to directly upgrade Analytics Exchange from version 14.x to version 15.1.1.

You cannot use the installer to upgrade from version 15.1.0 to 15.1.1. Instead, you can manually patch version 15.1.0.

Note

Before installing or upgrading AX Server, review the known issues: Installation and upgrade known issues

If you are upgrading from a version earlier than 14.x, contact Support for assistance.

The table below explains the upgrade paths for different versions of Analytics Exchange.

Analytics Exchange version currently installed Action Result
Analytics Exchange 15.1.0

Manually patch version 15.1.0 using log4j-2.17.1-patch-ax.zip

For more information, see Patch critical security vulnerabilities (CVE-2021-44832, -45105, -45046, and -44228).

Note

Using the Analytics Exchange installer to upgrade from version 15.1.0 to 15.1.1 is not supported. Use the manual patch.

 Analytics Exchange 15.1.0 patched, no need to upgrade to 15.1.1
Analytics Exchange 14.x

Run the AX Server 15.1.1 installer (ACLAX1511_Server_<edition>.exe)

If your organization also uses AX Engine Node, run the AX Engine Node 15.1.1 installer (ACLAX1511_EngineNode_<edition>.exe)

Analytics Exchange upgraded to version 15.1.1
Analytics Exchange 13

Contact Support for assistance.

Note

You cannot use the Analytics Exchange 15.1.1 installer to upgrade directly from version 13 to 15.1.1.

  

Back up your installation before you upgrade

Before you begin the upgrade process, back up your existing installation in case you need to restore the previous installation.

Stop the AX Server Windows services

  1. On the server where the services are running, open the Services window from the Administrative Tools dialog box.
  2. In the list of services, right-click the service and select Stop.

    Note

    If you are stopping the system or stopping more than one service, you must stop the services in the following order:

    • Analytics Exchange Connector
    • ACL Analytics Exchange Service
    • Analytics Exchange Database (PostgreSQL installations only)

Back up the Analytics Exchange database

For information about backing up your specific database instance, see one of the following:

Back up application files and sub-folders

On the server where AX Server is installed, back up the contents of the following subfolders:

  • App\TomCat\conf
  • Data\repository\datafiles (default location)

    If the datafiles sub-folder does not use the default location, or is not located on the server where AX Server is installed, you can check the dataFilePath property in the aclAuditExchange.xml file for the location.

Restart the AX Server Windows services

  1. On the server where the services are running, open the Services window from the Administrative Tools dialog box.
  2. In the list of services, right-click the service and select Start.

    Note

    If you are restarting the system or starting more than one service, you must start the services in the following order:

    • Analytics Exchange Database (PostgreSQL installations only)
    • ACL Analytics Exchange Service
    • Analytics Exchange Connector

Update any analytic scripts that reference a related .prf file

If you use the //FILE tag to reference a .prf preference file that overrides the global preferences file in your analytic scripts, you must update the reference to a version of the .prf file that comes with the latest version of the software when you upgrade. If you do not, the global preferences file is used instead of the older version of the .prf file you are referencing.

The name of the file contains the software version number, for example: aclwin12.prf.

Upgrade AX Server

For information about upgrading your specific configuration, see one of the following:

Review configuration file settings

If your organization previously made any changes to the AX Server configuration files in App\TomCat\conf, you need to manually restore the changes. Configuration file changes made by customers are not preserved during the AX Server upgrade.

Compare the versions of the files that you backed up with the upgraded versions. A file comparison tool can be helpful. Restore any configuration file changes, as required.

For a list of the configuration files in App\TomCat\conf, see AX Server configuration files.

Caution

Restore the changes individually in the upgraded files. Do not overwrite an upgraded version of a configuration file with an older, backed-up version of the file.

If you are uncertain about how to restore a configuration setting in an upgraded configuration file, contact Support.

ACL Connector for Analytics Exchange customers

If you are using the ACL Connector for Analytics Exchange to connect third-party reporting tools to analytic results via ODBC, it is recommended that you upgrade the server component after upgrading AX Server:

  1. Download the installer.
  2. Run the installation package.
  3. Follow the on-screen instructions.

For more information about running the installer, see Installing the ACL Connector for Analytics Exchange server component.