Installing and Uninstalling the Reporting Server on Windows

This page guides you through the necessary steps to install the Reporting Server on Windows.

Note:

The installation must be carried out by an administrator or a user with administration rights.

Once you have installed the Reporting Server, you have to configure it. The configuration page also provides tips for Windows and Linux. For more information, see Configuring and Managing the Reporting Server.

This page includes the following:

Prerequisites

Important!

Use the compatibility matrix (compatibility matrix) to check all relevant Automic Automation Intelligence components and prerequisites for vendor, version or setup information (Java version, browser compatibility and so on). For more information, see Compatibility Information.

Make sure you have the following prerequisites in place:

  • Java JDK 1.8 + is installed on the Reporting Server and the JAVA_HOME environment variable is configured accordingly. A full JDK installation is required to run the Reporting Server. The JRE (Java Runtime Envoirnment) is not sufficient.

  • Google Chrome is installed on the Reporting Server host.

For more information, see Preparing for the Reporting Server Installation.

Setup and Configuration

This section guides you through the configuration and installation of the Reporting Server using the install4j process.

To install the Reporting Server on Windows, do the following:

  1. Go to https://downloads.automic.com/ , log in with your Broadcom account and download the relevant version of the Reporting Server. 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 default location for the installation is C:\Program Files\terma-bi-windows-installer but you can change it, if needed. You can also define a destination directory, if you want to create shortcuts for all users.

    Note:

    You can use spaces when defining these file/directory paths.

  4. Once the script is running, you are prompted to configure the Reporting Server before installing the Reporting Server with the parameters you entered.

    Define the following:

    1. The Tomcat port of the Reporting Server. You can either use the default port (8080) or a different one. If the Reporting Server and the AAI server are on the same host, make sure that the Tomcat port is not the same as the port AAI server, for example 8090.

    2. The Tomcat shutdown port of the Reporting Server. You can either use the default port (8005) or a different one. If the default port is already in use, make sure you assign a different one.

    3. The AAI protocol that you want to use: 1) HTTP or 2) HTTPS, depending on if the AAI server is configured for non-TLS or TLS communication.

      For more information on how to set up TLS authentication, see Configuring the Reporting Server for TLS Authentication.

    4. The AAI port. The corresponding default port is set automatically when you choose a protocol: 8080 for HTTP and 8443 for HTTPS.

    5. The database type that you want to use for AAI reports: 1) MSSQL or 2) ORACLE.

      This is the database used by the AAI server.

    6. The hostname of the email server (SMTP host) used to send scheduled reports.

    7. The port (default 25) of the SMTP email server.

    8. The email address from which the scheduled reports must be sent.

    9. Whether the mail server requires authentication or not: 1) Y or 2) N.

      If you select 1) Y, you also have to define the name and password of the SMTP server.

    10. The location where chrome is installed. The chrome executable is required to generate graph report exports.

      Note:

      You can use spaces when defining this file/directory path.

  5. Once you are done with the definitions, the termaBi.config file is updated. Please check that the updated values are correct before continuing with the installation.

    Example

    Terma BI Reporting will be installed to C:\Program Files\aai-bi-server\bi-server

    Terma BI embedded DB password is set

    Terma BI embedded DB port is set to 5432

    Tomcat port will be 8090

    Tomcat shutdown port will be 8005

    Tomcat AJP port will be 8009

    JAWS protocol set to http

    JAWS host set to localhost

    JAWS port set to 8080

    Mail host will be example

    Mail from will be example@example.com

    Mail port will be 25

    Mail protocol will be smtp

    The location of Chrome will be set to C:\Program Files\Google\Chrome\Application\chrome.exe

     

    Authentication is not required for email. Set email user/password to default values.

    If the values are not correct, enter N to end the execution without installing the Reporting Server. This option allows you to re-run the script command and change your definition.

    If the values are correct, enter Y to proceed with the installation using the configuration that you defined.

    You can also change the configuration of the Reporting Server after the installation. For more information, see Configuring and Managing the Reporting Server.

  6. Once the installation is complete, you can either start or stop the Reporting Server.

    The Reporting Server starts as a Service: Apache Tomcat 9.0 jasperreportsTomcat. A second service is installed for the internal Reporting Server database: jasperreportsPostgreSQL.

    Also, two desktop icons are created during the installation process which allow you to start and stop the service.

Starting and Stopping the Reporting Server

You can start and stop the aai-bi-server service using the Start JRS Service and Stop JRS Service desktop icons respectively.

You can also use the services.msc directly along with the PostgreSQL database. To do so, do the following:

  • Open a Command Prompt and navigate to your Reporting Server installation directory.

  • Run the respective command to either start or stop the Reporting Server:

    To start the Reporting Server:

    servicerun.bat START

     

    To stop the Reporting Server:

    servicerun.bat

  • Alternatively, you could use the full path:

    To start the Reporting Server:

    C:\ReportingServer\servicerun.bat START

     

    To stop the Reporting Server:

    C:\ReportingServer\servicerun.bat

For more information, see Stopping, Starting, Restarting the AAI Reporting Server .

Uninstalling the Reporting Server on Windows

To uninstall a Reporting Server installation, do the following:

  • Go to the Reporting Server installation directory, for example, C:\BiReporting

  • Run the bi-uninstaller.exe to uninstall.

The report configuration is retained.

See also: