Install or Upgrade for an External CA Business Intelligence JasperReports Server

There are two possible deployment paths for CA Business Intelligence JasperReports Server (CABI Server). This article describes a deployment with an external CABI Server.
uim902
external_cabi
There are two possible deployment paths for CA Business Intelligence JasperReports Server (CABI Server). This article describes a deployment with an external CABI Server.
Deploying the cabi_external probe allows a separate CABI Server instance to communicate with CA UIM and other CA Agile Central products. Select this deployment type if you want to use a CABI Server instance that is
NOT
deployed on a robot. You must deploy the CABI Server instance. If you want to share the CABI Server instance with multiple CA Agile Operations products, see Unified Dashboards and Reporting for Infrastructure Management.
  • UIM 20.3.3 has removed dependency on CA Business Intelligence (CABI) for rendering the native OC screens: Home page, Group view page, Device view page, and Monitoring Technologies (probes) view page. Custom and Out-of-the-Box dashboards and reports are still rendered by using CABI; that is, they have a dependency on CABI. However, the native OC screens are no longer dependent on CABI (Jaspersoft) and are rendered by using HTML5. For more information about the native OC screens using HTML5, see the Configuring and Viewing Monitoring Data article or the "Removing CABI Dependency (Native Operator Console)" section in the UIM 20.3.3 article.
  • If you do not need to view dashboards and reports for other CA Agile Central products, we recommend Install or Upgrade for a Bundled CA Business Intelligence JasperReports Server.
  • You can migrate from a bundled CABI Server installation to an external CABI Server installation. For more information, see Migrate from Bundled to External Configuration.
  • Before proceeding with the integration of CABI JasperReports Server and UIM, make sure you have different servers for CABI Jasper server, CABI robot and Operator Console (OC).
  • For more information on CA Business Intelligence JasperReports Server (to deploy cabi_external 3.32), review the CABI installation article.
  • For more information on CA Business Intelligence JasperReports Server (to deploy cabi_external 3.40), review the CABI installation article.
Contents
Software Requirements
The following table lists the required software. For a matrix of software versions for a specific release, see CA Business Intelligence with CA UIM.
Software
Download
Notes
CA Business Intelligence JasperReports Server for Unified Dashboards and Reporting for Infrastructure Management
support.broadcom.com, Download Management. See Notes.
A Support login is required to download.
  • Unified CABI 7.1.1 (Windows) -- Controlled release.
  • Unified CABI 7.1.1.1 (Linux) -- GA release.
    Download the Linux GA release from the support.broadcom.com location.
Jasper Server version is 7.1.1
CA UIM
support.broadcom.com, Download Management
A CA support login is required to download.
cabi_external probe
Add to the CA UIM archive. A CA support login is required to download.
ump_cabi portlet
Add to the CA UIM archive. A CA support login is required to download.
uim_core_dashboards_pack
Add to the CA UIM archive. A CA support login is required to download.
Report packages:
  • uim_unified_reporter_pack
  • uim_cabi_health_report_pack
Add to the CA UIM archive. A CA support login is required to download.
Dashboard packages: uim_<
technology_name
>_dashboards_pack
Add the appropriate dashboard packages to the CA UIM archive. A CA support login is required to download.
The dashboard packages are only required if you need to view data for the specific technology. For example, the uim_aws_dashboards_pack dashboard package is only required if you must view data for your AWS environment. For a list of available dashboard packages, see CA Business Intelligence with CA UIM.
Hardware Requirements
The CABI Server (CA Business Intelligence JasperReports Server) software is installed on a system with the following minimum resources:
  • CPU: 2.8-GHz quad-core processor
  • Memory: 8-GB RAM
  • Disk Size: 100-GB
If you want to share a single CA Business Intelligence (CABI) server instance with multiple CA Agile Operations products, additional requirements exist. For more information, see Extend your CA Products with Unified Dashboards and Reporting for Infrastructure Management.
Environment Requirements
This process requires the following environment:
  • A server instance with the CA Business Intelligence JasperReports Server for Unified Dashboards and Reporting for Infrastructure Management (CABI Server) software. This instance is
    NOT
    a hub or robot.
  • A CA UIM instance. For information about installation, see:
  • Download, update, or import the following packages to the Archive:
    • cabi_external probe
    • cabi packages
    • dashboard packages
    • report packages
  • (Optional) Secure Hub and Robot - The secure hub and robot provide robust hub-to-hub and robot-to-hub communication. To upgrade CABI in a secure setup, upgrade the CABI robot to a secure state and then perform the CABI upgrade. For more information about the secure setup and how to deploy certificates, see Secure Hub and Robot.
  • (
    MySQL Only
    ) If you are using MySQL for your CABI Server database, you must change the default memory settings. This database is for the CABI users, reports, and dashboards. Change the following settings so that the CA Business Intelligence dashboard deployment is successful:
    • Set
      max_allowed_packet=32M
    • Set
      innodb_log_file_size=356M
    • Set
      table_definition_cache=2000
Your dashboards import fails if the above recommended settings are not updated for MySQL.
  • (
    Microsoft SQL Server Windows Authentication Only
    ) If you are using Microsoft SQL Server Windows Authentication, the CABI Server system, cabi_external probe robot, and Operator Console (OC) robot must have Windows operating systems. No requirements exist for matching operating systems if you are NOT using Microsoft SQL Server Windows Authentication.
Do not install or configure CABI Server using Cygwin.
Unified CABI and cabi_external Matrix
The following table explains the Unified CABI and cabi_external matrix:
Jasper Server Version
Unified CABI Version
cabi_external version
UIM Server Version
Download Location
7.5
NA
NA
NA
NA
7.1.1
  • 7.1.1 (Windows) - Controlled release
  • 7.1.1.1 (Linux) - GA release
4.20
20.1 and 20.3
7.1.1
  • 7.1.1 (Windows) - Controlled release
  • 7.1.1 (Linux) - Controlled release
4.10
9.20
These are controlled releases.
6.4.3
6.4.3 (Windows and Linux)
3.40
9.0.2 SPI (9.1.0)
6.3.0
6.3.0
3.32
9.02
Download theJaspersoft 6.3 for CA Spectrum for Windows, Solaris and Linux.tar.gz package from support.broadcom.com.
6.3.0
6.3.0
3.30
9.02
Download the Jaspersoft 6.3 for CA Spectrum for Windows, Solaris and Linux.tar.gz package from support.broadcom.com.
6.3.0
6.3.0
3.20
8.51
Download the Jaspersoft 6.3 for CA Spectrum for Windows, Solaris and Linux.tar.gz package from support.broadcom.com.
Configure CA UIM for an External CABI Server
Use this procedure to configure CA UIM to connect to a new CABI Server instance.
Process Overview
The following diagram shows the sequence of tasks to complete.
External CABI Process
External CABI Process
(Microsoft SQL Server Windows Authentication Only) Configure Windows Authentication
Use this procedure if you must enable Windows authentication on the CABI Server.
Follow these steps:
  1. Grant the Windows Authentication user full control of the following directories:
    • The CABI Server installation directory.
    • The CABI Tomcat installation directory if the
      Apache-Tomcat
      directory is not included in the CABI Server installation directory.
  2. Modify the CABI Tomcat service to run as a Windows authentication user.
    1. Open the Windows Services console.
    2. Right click the Service and click
      Properties
      .
    3. Select the
      Log On
      tab.
    4. Select
      This account
      .
    5. Enter the Account information for the Windows authentication user.
    6. Click
      Ok
      .
    7. Restart the CABI Tomcat service.
  3. Install SQL Server drivers on the CABI Tomcat server. The
    Apache-Tomcat
    directory is usually in the CABI Server installation directory.
    1. Find the Microsoft JDBC Driver for SQL Server files from the following location in your UIM installation folder:
      • sqljdbc6-6.2.2.jar file from
        \Nimsoft\probes\service\<probe>\lib
      • sqljdbc_auth.dll from
        \Nimsoft\lib
    2. Extract the self-contained zip file.
    3. Copy the
      sqljdbc_auth.dll (version: 6.2.2.1)
      in the extracted directory to the CABI Tomcat bin directory.
    4. Copy the
      sqljdbc6-6.2.2.jar
      in the extracted directory to the CABI Tomcat lib directory.
    5. Restart the CABI Tomcat server.
  4. Run the cabi_external probe as a Windows authentication user.
    1. On the robot with the probe, go to
      Administrative Tools > Services
      and double-click on
      Nimsoft Robot Watcher.
    2. Select the
      Log On
      tab.
    3. Change the account to the same account and password that is used in the
      data_engine
      and the primary UIM server.
    4. Click
      OK
      .
    5. Right-click on
      Nimbus Robot Watcher
      and select the
      Restart
      option.
    6. Close the windows.
    7. Restart the  robot.
Deploy the cabi_external Probe
The cabi_external probe functions as a gateway for CA Business Intelligence JasperReports Server (CABI Server). This configuration allows you to share the CABI Server instance with multiple CA Agile Operations products. You view dashboards on the CABI Server.
The UIM Server installer creates a .pem file (certificate.pem) in the <Nimsoft>\security folder. The .pem file is a symmetric key that is shared with the required robots, which is then used for communication with the data_engine probe. You copy this .pem file to the remote Operator Console (OC), UR, and CABI robots and provide the location of the file in the robot.cfg file (cryptkey = <.pem file location>). Furthermore, if any impacted probe is not on the same computer where data_engine is present, copy the generated .pem file to the robot computer (where data_engine is not available) and update the robot.cfg file with the .pem file location on that computer. For more information about the robot.cfg file configuration, see Configure robot.cfg.
Follow these steps:
  1. Verify that the cabi_external probe, uim_core_dashboards_pack, and report packages are in the archive.
    UIM 20.3.0 installer comes with
    uim_core_dashboards_pack
    version 2.46 and
    uim_unified_reporter_pack
    version 1.04 which are unsupported for the
    cabi_external
    probe version 4.20. Follow these steps for the
    cabi_external
    probe to work:
    1. Remove
      uim_core_dashboards_pack
      version 2.46 and
      uim_unified_reporter_pack
      version 1.04.
    2. Deploy
      uim_core_dashboards_pack
      version 2.45 and
      uim_unified_reporter_pack
      version 1.03 from the Archive.
  2. Deploy the packages on a robot. The probe automatically deploys any package dependencies that exist in the archive. For example, the uim_core_dashboards_pack and report packages. For more information about how to deploy a probe package, see the Deploy Packages article. The cabi_external probe turns red in admin console and a No Restart error appears in the probe log file. This error is expected behavior. Continue with the next step.
  3. Open
    Raw Configure
    for the probe. For more information, see Configure a Probe.
  4. Go to
    setup
    .
  5. Change the cabi_url key value to the URL for the CABI Server. The format is http://<cabi_server_name_or_IP>:<port>/<webapp>
    where <webapp> is usually jasperserver-pro.
  6. Choose one of the following steps:
    • If the default superuser account is still in use on the CABI Server, no additional configuration is required.
    • If you modified the default superuser account, perform the following steps:
      1. Enter the username as the value for the key
        cabi_rest_user
        .
      2. Create the key
        cabi_rest_password_cleartext
        . Then enter the password for the user account as the key value. When the probe restarts, this password is encrypted and the cabi_rest_password_cleartext key is removed.
  7. Save your changes and activate the cabi_external probe.
  8. Verify that the installation is complete. The cabi_external probe might be active, but the installation process might not be complete. Go to the cabi_external probe log file and look for the following messages:
    <
    date_time
    > [main, cabi_external] cabi installed successfully.
    ...
    ...
    ...
    <
    date_time
    > [UserSynchronizationThread, cabi_external] Finished synchronizing users between UIM and CABI
    The wasp probe automatically starts when the process is complete.
Configure CABI Server for CA UIM
Additional installation steps are required to configure CABI Server to work with an instance of CA UIM.
Follow these steps:
  1. Log in to the CABI server as the user who is configured to run the CABI Tomcat service.
  2. Go to the filesystem of the robot with the cabi_external probe.
  3. Copy the
    uim-cabi-overlay-installer.jar
    file in
    <UIM_installation>/probes/service/cabi_external/config/bin
    .
  4. Add the file to the CABI Server root directory. Use the appropriate path for your operating system:
    • Windows:
      <CABI_Server_installation>/Program Files/CA/SC/CA Business Intelligence
    • Unix:
      <CABI_Server_installation>/opt/CA/SharedComponents/CA Business Intelligence
  5. Run the installer on CABI Server:
    jre/bin/java -jar uim-cabi-overlay-installer.jar
  6. Restart the CABI web server.
New packages for predefined reports and dashboards are released periodically.
Upgrade cabi_external Probe
The instructions in this section are for users that want to upgrade the cabi_external probe. You can upgrade cabi version 4.10 to cabi_external version 4.20.
  1. The UIM Server installer creates a .pem file (certificate.pem) in the <Nimsoft>\security folder. The .pem file is a symmetric key that is shared with the required robots, which is then used for communication with the data_engine probe. You copy this .pem file to the remote Operator Console (OC), UR, and CABI robots and provide the location of the file in the robot.cfg file (cryptkey = <.pem file location>). Furthermore, if any impacted probe is not on the same computer where data_engine is present, copy the generated .pem file to the robot computer (where data_engine is not available) and update the robot.cfg file with the .pem file location on that computer. For more information about the robot.cfg file configuration, see Configure robot.cfg.
  2. In an upgrade scenario, if you are upgrading CABI in a secure setup, ensure that you bring your CABI robot to the secure state by deploying the appropriate certificates and then updating the robot version to the secure version. After that, you upgrade CABI. For more information about the secure setup and how to deploy certificates, see Secure Hub and Robot.
Redeploy the cabi_external Probe
Follow these steps:
  1. Verify that the latest cabi version, cabi_external probe, uim_core_dashboards_pack, and report packages are in the archive.
  2. Deploy the packages to the location of your existing cabi_external probe.
    For more information about how to deploy a probe package, see the Deploy Probes with Admin Console article.
  3. Verify that the installation is complete. Go to the cabi_external probe log file and look for the following message:
    <
    date_time
    > [main, cabi] cabi installed successfully.
    ...
    ...
    ...
    <
    date_time
    > [UserSynchronizationThread, cabi] Finished synchronizing users between UIM and CABI
Add Predefined CA Business Intelligence Dashboard Content
The dashboard packages for a specific monitoring technology are only required if you have a business need to monitor the specific technology. For example, you only need the uim_aws_dashboards_pack if you plan to view dashboards for an Amazon Web Services environment. If you are using specific monitoring technology dashboards, you should update the packages when a new package version is available.
Follow these steps:
  1. Verify that you are running the most current version of the cabi or cabi_external probe. If you are not using the current version, update your probe, uim_core_dashboards_pack packages, and any package dependencies. We recommend that you use the most current packages for your probe version. For more information about supported packages and versions, see CA Business Intelligence with CA UIM.
  2. Deploy the desired uim_<probe name>_dashboards_pack packages to the robot running the cabi or cabi_external probe.
View Dashboards
You view dashboards on the CABI Server.
Enter in a browser:
http://<CABI_Server_IP or hostname>:<port>/<web_app>
Where
<port>
is the port for the CABI Server Apache Tomcat server instance, and
<web_app>
is the CABI Server web application name. The default port value is 8080 and the default web application name is jasperserver-pro. An example of a URL is, http://localhost:8080/jasperserver-pro.
Configure the SMTP Email Setting for Emailing Scheduled Reports
Reports in UIM are managed by CABI; therefore, you must configure the SMTP settings on the CABI server.
Follow these steps:
  1. Stop the CABI server.
  2. Navigate to the ..\CA Business Intelligence\apache-tomcat\webapps\jasperserver-pro\WEB-INF folder.
  3. Create a backup of the js.quartz.properties file.
  4. Edit the js.quartz.properties file as shown below; edit the bold values to match with your setup:
    • report.scheduler.web.deployment.uri=
      http(s)://<cabi-ip-or-fqdn>:<port>/jasperserver-pro
    • report.scheduler.mail.sender.host=
      smtp.corp.com (The name of the computer hosting the email server.)
    • report.scheduler.mail.sender.username=
      smtp_user_name_(The name of the email server user that JasperReports Server can use.)
    • report.scheduler.mail.sender.password=
      smtp_password_ (The password of the email server user.)
    • report.scheduler.mail.sender.from=
      [email protected] (The address that appears in the From field on email notifications.)
    • report.scheduler.mail.sender.protocol=
      smtp (The protocol that the email server uses. JasperReports Server supports only SMTP.)
    • If your email server does not require a user name or password, leave the values empty; for example:
      • report.scheduler.mail.sender.username=
      • report.scheduler.mail.sender.password=
    If you add # at the start of the above lines, it will corrupt the file and CABI will be unable to start.
  5. Restart the CABI server.
Optional Tasks
The following tasks are optional and not required for all CA UIM environments. After you have successfully installed your CABI server, review the following tasks. Complete any of the tasks that you need for your environment.
Configure CABI Server to Use HTTPS
We recommend that you consult your network security engineers and compliance specialists regarding your specific security requirements. In general, industry-standard security requirements mandate the use of SSL encryption for client/server communications on an untrusted network.
Follow these steps:
  1. Configure wasp for HTTPS for UIM or Operator Console (OC) as described in the article Configure HTTPS in Admin Console or Operator Console (OC).
  2. Configure HTTPS for your external CABI Server as described in the
    'Configuring SSL'
    article in the CABI Jasperserver documentation.
  3. Open raw configure for the cabi_external probe.
  4. Go to
    Setup
    and add the key
    cabi_url
    with the value:
    https://<CABI_Server_IP or hostname>:<port>/<webapp>
    Where
    <port>
    is the HTTPS port and <webapp> is usually jasperserver-pro.
  5. Restart wasp on the Operator Console (OC) robot.
  6. Instruct users who access CABI Server directly to use the URL:
    https://<CABI_Server_IP or hostname>:<port>/<webapp>
    Where
    <port>
    is the port for https communications
    <webapp>
    is usually jasperserver-pro. The default HTTPS port number is 8443. For example,
    https://12.123.123.12:8443/jasperserver-pro
    .
  7. Instruct users to accept any browser-specific security certificate warnings that are required to proceed to the CABI Server home page.
Change the Frequency of Backups
A backup of the dashboards pack is created when you upgrade the cabi_external probe or dashboard package. Use the auto-backup settings to control the frequency of backup file creation. You can use these options to save resources if you frequently upgrade the cabi_external probe and dashboards.
Follow these steps:
  1. Go to raw configure for the cabi_external probe.
  2. Set the value for the following keys as needed:
    • auto_backup_fequency_in_hours - The cabi_external probe only uses this key when a dashboard is available to import and the auto_backup_on_import_enabled key is set to
      yes
      . If the time of the last backup is less than the specified frequency, then a backup is created. A setting of 0 indicates that no backup is created. The default setting is
      24
      hours.
    • auto_backup_on_import_enabled - This key indicates if a backup file is created for dashboard packages. A backup file is created when set to yes. The default setting is
      yes
      .
    • auto_backup_on_import_max_time_in_secs - This key is the amount of time that is allowed to pass before an error message is generated in the cabi_external probe log file. The default setting is
      1800
      seconds.
View CABI dashboards in Operator Console (OC)
Use this procedure to view the predefined CABI dashboards for CA UIM in Operator Console (OC).
Update the ump_cabi Portlet
Use this procedure to deploy the ump_cabi portlet package to view the predefined CABI dashboards in Operator Console (OC).
Follow these steps:
  1. On the robot running Operator Console (OC), deploy the most current version of the
    ump_cabi
    package.
  2. Verify that you can view the predefined dashboards. Go to the
    Dashboards
    in the left navigation of the Operator Console (OC) and select a CA Business Intelligence dashboard. For example,
    Infrastructure Management Overview
    .
Customize the Report Logo
You can customize the appearance of your CABI Dashboard reports to match your organization's name and logo.
Follow these steps:
  1. Login to Operator Console (OC) using the administrator credentials.
  2. Open CABI Server Home using the url
    http(s)://<CABI_Server_IP or hostname>:<port>/cabijs
    in another tab of the browser.
  3. From the menu, select
    View
    , Repository and navigate to Public, ca, Unified Infrastructure Management, resources, library, health, images.
  4. Select the company_logo.png and click
    Edit
    to replace with your logo.
  5. Similarly, to change the logo for all reports globally, then navigate to Public, ca, Unified Infrastructure Management, resources, common, images.
  6. Select the company_logo.png and click
    Edit
    to replace with your logo in all the reports.
External CABI Server Firewall Rules
The following table defines the ports and directions that must be open through a firewall for an external configuration. For additional information, see Firewall Port Reference.
Communication Required
Ports
Direction
Firewall Rules
Details
cabi_external Probe to CABI Server
80 or 443; configurable
Outbound
Allow outbound to CABI Server.
Port 80 by default or port 443 for HTTPS. You can use another configured port value for HTTP or HTTPS. The value depends on your choice during the cabi_external probe installation. The configurable range of ports is 1 through 65535.
cabi_external Probe to UIM Database
1433 (Microsoft SQL Server);
1521 (Oracle);
3306 (MySQL)
Outbound
Allow outbound on respective port for UIM database.
The port depends on the database type and configuration.
External CABI Server
80 or 443; configurable
Inbound
Allow inbound from cabi_external probe.
Port 80 by default or port 443 for HTTPS. You can use another configured port value for HTTP or HTTPS. The value depends on your choice during the CABI Server installation. The configurable range of ports is 1 through 65535.
UIM Database to cabi_external Probe
1433 (Microsoft SQL Server);
1521 (Oracle);
3306 (MySQL)
Inbound
Allow inbound from cabi_external probe on respective port for UIM database.
The port depends on the database type and configuration.
Troubleshooting
  • While upgrading CABI probe, the probe may fail to start and you will get a "max restart alarm message". You will see a message about backup related content in the log and have partial java dump files in the cabi directory. This can happen if there are a large number of custom reports that require a larger amount of memory to backup then the probe is already configured for.
    To resolve this issue:
    • Increase the
      java_mem_init
      and
      java_mem_max
      options in startup->opt section of the cabi_external probe's raw configuration options.
    • Start by setting the MIN to 1 GB and the MAX to 2 GB to try and resolve this issue, you may need to increase this depending on the number of custom reports. This can be done either from Infrastructure Manager (IM) or from Admin Console (AC).
    • Deactivate and activate the cabi_external probe which will continue with the upgrade process.