Installing reports

Install the reports package on the Tivoli® Common Reporting server.

Before you begin

Before you install reports, you must complete the following steps:
  • Configure the reports installation image. If you configured the reports installation image, you see one of the following reports installation packages in the directory that you specified during configuration. The default folder for the reports installation package is /opt/ibm/ccm/depot.
    • apm_advanced_reports_8.1.4.0.zip
    • apm_base_reports_8.1.4.0.zip
    For more information, see Configuring the reports installation image.
  • Ensure that network connectivity exists between the Tivoli Common Reporting server and the Cloud APM server. The install_reports.sh script uses port 8091 to send HTTP requests to the Cloud APM server.

Procedure

  1. Copy the reports installation package from the Cloud APM server to the Tivoli Common Reporting server and extract the reports installation package.
  2. On the Tivoli Common Reporting server, run the installation script with root user privileges:
    ./installReports.sh
    AIXNote: If you want to install reports packages on an AIX system with the Korn shell set as default, you must ensure that the Bash shell is available. You must also edit the ./installReports.sh script to change the line
    #!/bin/sh
    to
    #!/bin/bash
  3. Select packages to install from the following reports packages by entering the corresponding numbers:
    • Response Time Monitoring Agent Reports (not available in IBM® Cloud Application Performance Management, Base Private)
    • Monitoring Agent for WebSphere® Applications Reports
    • Monitoring Agent for Synthetic Playback Reports (not available in IBM Cloud Application Performance Management, Base Private)
  4. Enter the installation path for Jazz® for Service Management.
  5. Enter the user name and password for a Jazz for Service Management user with administrator privileges.
  6. Enter the password of a Cloud APM administrator.
    Important: This password is the password of the Internal Cloud APM smadmin user. The smadmin password is the same as the apmadmin user password that you specified at installation. The default value is apmpass. If you cannot remember the smadmin password, you can change it using the script that is described in the following topic: Default users and passwords.
  7. Enter the fully qualified hostname for Tivoli Common Reporting. For more information about Tivoli Common Reporting, see Downloading and installing Tivoli Common Reporting.
  8. Verify Cognos® Application Firewall and Cross Site Scripting (XSS) settings in IBM Cognos and Cloud APM to allow access to reports from the Application Performance Dashboard.
    1. Navigate to the installation location of Tivoli Common Reporting and run Cognos Configuration.
      The default location is /opt/IBM/JazzSM/reporting/cognos/bin64/tcr_cogconfig.sh.
    2. In the Component Properties table, ensure that Enable CAF validation? and Is third party XSS checking enabled? are set to True.
    3. Restart the Tivoli Common Reporting server.
    4. In the Cloud APM console Console, click Advanced Configuration > UI Integration > Parameters and set Cognos Reporting Requires XSS Validation as True.

Results

The reports packages are installed successfully. The Tivoli Common Reporting URL is added to the Cognos Reporting URL field in Advanced Configuration > UI Integration > Parameters in the Performance Management console. The Cognos Reporting URL format is https://reporting-server-hostname:port/tarf/servlet/dispatch/secured.

For Tivoli Common Reporting 3.1.1 and higher, the Cognos Reporting URL format is https://reporting-server-hostname:port/tarf/servlet/reporting/secured.

If you are using Tivoli Common Reporting 3.1.1 or later, you must use the Cloud APM console to manually set the Cognos Reporting URL field in the Advanced Configuration > UI Configuration > Parameters section.

Important: If the installation script does not complete successfully, review the error messages in the latest log file in the /tmp/apm_reports_installer directory.

What to do next

You are now ready to view reports in the Application Dashboard. For more information, see Reports.