Upgrading the Reporting Server from v1.1.x

As an AAI administrator, you upgrade the Reporting Server in Windows or Linux. This page guides you through the upgrade process from version 1.1.x.

Important!
  • If you are on version 1.x, you have to first upgrade to version 2.0.0 and then to a higher (2.0.x) version.

  • You must perform the upgrade from 2.0.x to 2.0.2 manually.

  • After upgrading, make sure that you configure the Reporting Server definitions accordingly, see Configuring the Reporting Server. No upgrade is complete without this step.

This page includes the following:

Considerations

Make sure you consider the following issues before upgrading:

  • Do not stop the Reporting Server as it must be running for the upgrade.

  • You can upgrade the Reporting Server at any time. You do not need to shut down the AAI Server nor take down the connectors.

  • Please note that, even on very fast hardware, your Reporting Server upgrade may take a minimum of ten minutes to complete.

  • If you are upgrading from version 1.0 or 1.1, you need to add mail options to the command line or add the parameters listed below to the corresponding configuration file (termaBi-config.bat for Windows, termaBi.config for Linux).

    set MAIL_AUTH=<true or false>
    set MAIL_HOST=<MAIL_HOST>
    set MAIL_PORT=25
    set MAIL_PROTOCOL=smtp
    set MAIL_USERNAME=<MAIL_USERNAME>
    set MAIL_PASSWORD=<MAIL_PASSWORD>
    set MAIL_FROM=<MAIL_FROM>

Upgrading the Reporting Server on Windows

To upgrade the Reporting Server on Windows, you have to use the same terma-bi-windows-installer executable file that was used for the installation.

  1. If you have not done so yet, go to https://downloads.automic.com/, log in with your Broadcom account and download the relevant AAI product or solution. For more information, see Downloads.

  2. Install the terma-bi-win-installer-i4j archive, extract it and run the terma-bi-windows-installer-<version>.exe file to setup the installer.

  3. Follow the instructions of the Install4J wizard.

    The installer automatically detects whether a previous installation exists and starts the upgrade process.

    If the upgrade process detects that there is no Chrome available on the system, or that the current version is already up-to-date, a corresponding message is displayed.

To access the upgrade logs, check the upgrade-logs.txt file located in the upgrade directory terma-bi-win-installer-i4j-<version>\upgrade.

Upgrading the Reporting Server on Linux

This section outlines all relevant issues for a successful upgrade on Linux.

Prerequisites

Before upgrading your Reporting Server from v.1.1.x on Linux, make sure you meet the following requirements:

  • Ensure that the current Reporting Server installation is working correctly.

  • Backup your current Reporting Server installation or snapshot the virtual machine on which is running with the machine powered off.

  • Ensure that there is no systemd service defined for the Reporting Server. If there are custom services, make sure you disable and remove them, as the upgrade will install a systemd service.

  • Ensure that systemctl daemon-reload has been executed as root after removing the systemd service definition.

  • Ensure that the symlink from /etc/aai/bi-reporting/terma-bi-install.conf points to the termaBi.config file corresponding to your current installation.

    Note:

    Make sure that the termaBi.config file is available in your system as it is required for the upgrade process. If the file is not available, it must be created using the parameters of the current version (the one that you want to upgrade).

    The Reporting Server service account must be able to read and write the symlink configuration, as well as create files in the /etc/aai/bi-reporting/ directory.

Upgrade Process

Important!

The Reporting Server is installed in the /opt/bi-server/server directory by default and the path is not customizable which means that you cannot change the installation directory.

To upgrade the Reporting Server on Linux, you have to use the same files that were used for the installation.

  1. If you have not done so yet, go to https://downloads.automic.com/, log in with your Broadcom account and download the relevant AAI product or solution. For more information, see Downloads.

  2. Unpack the .zip file to get the terma-bi-linux-installer-<version>.rpm and terma-bi-configure-rpm.sh files.

  3. Run terma-bi-configure-rpm.sh.

    sudo JAVA_HOME=</opt/java> ./terma-bi-configure-rpm.sh

Note:

After upgrading the Reporting Server, the Jasperserver-pro password for the superuser is reset to the default TermaPassword. If you are not using the default password, make sure you define it again (http(s)://hostname:post/jasperserver-pro/login.html).

See also: