Installing and Uninstalling the Reporting Server on Linux

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

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 the Reporting Server.

This page includes the following:

Download the Installation Software

Download the Reporting Server software installation bundle from www.broadcom.com and move it to a directory or folder on the server to be used as the Reporting Server.

Installation Steps

  • Uncompress the Reporting Server software Installation bundle for Linux (tgz file).

  • The Reporting Server installation for Linux can only be completed using the command-line. The installer can not be run as root. Run the installation command as a user who has permissions to write files into the current directory and the directory specified as the Reporting Server installation home.

Linux Command Line Options

Important!

You cannot use the Linux CLI option with the .rpm script. This option is only available when using the terma-bi-installer.sh file.

The installer can not be run as root; therefore, run the installation command as a user with permissions to write files into the current directory and the directory specified as the Reporting Server installation home.

Before running the terma-bi-installer.sh common, verify that Java 1.8 is installed using the following command:

/home/apps/BiReporting] java -version

  • Java version 1.8.0_121

  • Java SE Runtime Environment (build 1.8.0_121-b13)

  • Java HotSpot 64-Bit Server VM (build 25.121-b13, mixed mode)

To get a list of the installation options for the Reporting Server, run the following command below specifying the -h option:

/home/apps/BiReporting] ./terma-bi-installer.sh -h

Usage

./terma-bi-installer.sh [options]

Options

Option Description
-d, --directory

Directory for installation. Required

For instance --directory /opt/apps/BiReporting. -d /opt/apps/BiReporting.

-w, --db-password Terma BI embedded DB password. Required
-r, --db-port Terma BI embedded DB port. Optional. Default is 5432
-t, --port

Terma BI Report Server Tomcat port (default 8080). Changed this port if the Automic Automation Intelligence Server is already using port 8080 and both run on the same physical server.

-s, --shutdown-port Tomcat shutdown port. Optional. Default is 8005
-a, --ajp-port Tomcat AJP port. Optional. Default is 8009
--jaws-protocol

Automic Automation Intelligence server protocol. Optional. Default is http

-j, --jaws-host Automic Automation Intelligence server host. Required
-p, --jaws-port Automic Automation Intelligence S port. Optional. Default is 8080
-o, --jaws-oracle Automic Automation Intelligence database type is set to Oracle when specified. Otherwise, it is set to MS SQL Server.
--mail-host Email server hostname for sending scheduled reports. Required
--mail-from Email address to send reports from. Required
--mail-port Email server port. Optional. Default is 25
--mail-protocol Email server protocol. Optional. Default is SMTP
--mail-auth Email server authentication required when specified. Optional.
--mail-username Email server user name. Required if --mail- auth is specified
--mail-password Email server password. Required if --mail- auth is specified
-f, --file

Config file. This config file is read instead of the above parameters.

A config file named termaBi.config will be written at the end of any successful installation which will be in the correct format to use as this config file.

-y, --yes Accept all prompts. No user input is required.
-h, --help For this help

Linux Command Examples

Usage: terma-bi-installer.sh [-d Directory for installation] [-j AAI server host] [-o AAI database type is set to Oracle] [-w Reporting Server embedded database password] [-t Reporting Server Tomcat port] [--mail-host Email server host] [--mail-from Email address to send reports from]

The user is prompted with the following: Continue with these settings? [y/n]

Note:

The installation includes a build of the software that can take up to 10 minutes. There might not be any output displayed on the screen during this time.

SQL Server Database Example

[/home/apps/BiReporting] ./terma-bi-installer.sh -d /home/apps/BI_Installer -j Prod01 -w postgres -t 8090 --mail-host TSL-U01 --mail-from john.doe@broadcom.com

  • Terma BI Reporting server will be installed to directory /home/apps/BI_Installer

  • JAWS host set to Prod01

  • Terma BI embedded DB password is set

  • Tomcat port will be 8090

  • Mail host will be set to TSL-U01

  • Mail from will be set to john.doe@broadcom.com

  • Continue with these settings? (y/n) y

Oracle Database Example

[/home/apps/BiReporting] ./terma-bi-installer.sh -d/home/apps/BI_installer -j Prod01 -o -w postgres -t 8090 --mail- host TSL-U01 --mail-from john.doe@broadcom.com

  • Terma BI Reporting will be installed to directory /home/apps/BI_installer

  • JAWS host set to Prod01

  • JAWS Database is set to Oracle

  • Terma BI embedded DB password is set

  • Tomcat port will be 8090

  • Mail host will be set to TSL-U01

  • Mail from will be set to john.doe@broadcom.com

  • Continue with these settings? (y/n) y

Mail Authentication Example

[/home/apps/BiReporting] ./terma-bi-installer.sh -d/home/apps/BI_installer -j Prod01 -o -w postgres -t 8090 --mail-auth --mail-host TSL-U01 --mail-username jdoe --mail-password password --mail-from john.doe@broadcom.com

  • Terma BI Reporting will be installed to /home/apps/BI_installer

  • JAWS host set to Prod01

  • JAWS Database is set to Oracle

  • Terma BI embedded DB password is set

  • Tomcat port will be 8090

  • Mail auth will be set to true

  • Mail host will be set to TSL-U01

  • Mail username will be set to jdoe

  • Mail password is set

  • Mail from will be set to john.doe@broadcom.com

  • Continue with these settings? (y/n) y

Uninstalling the Reporting Server on Linux

To uninstall a Reporting Server installation, do the following:

  • Go to the Reporting Server installation directory, for example, /home/BI_Installer

  • Execute the uninstall script:

    ./terma-bi-uninstaller.sh

The report configuration is retained.

See also: