Install or Upgrade for a Bundled CA Business Intelligence JasperReports Server

There are two possible deployment paths for CA Business Intelligence JasperReports Server (CABI Server). This article describes a bundled CABI server deployment.
uim851
There are two possible deployment paths for CA Business Intelligence JasperReports Server (CABI Server). This article describes a bundled CABI server deployment.
cabiBundled
The bundled deployment installs and configures an instance of CABI Server on a CA UIM robot. This configuration simplifies the CABI Server installation process if you only need to use a CABI Server instance with CA UIM. You
cannot
use this CABI Server instance with other CA Agile Operations products.
Warning!
During the cabi probe package deployment, wasp restarts on the robot with CABI Server. The deployment can take approximately 10 to 20 minutes to complete.
Do not attempt to restart wasp before the deployment is complete.
If you try to restart wasp before the deployment is complete, CABI Server will not install successfully.
Contents
3
Software Requirements
The following table lists the minimum 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
N/A
Installed by cabi probe.
CA UIM
A CA support login is required.
cabi 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_library_reports_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.
Environment Requirements
This process requires the following environment:
  • A CA UIM instance. For information about installation, see:
  • Download, update, or import the following packages to the Archive:
    • cabi probe
    • cabi portlet
    • dashboard packages
    • report packages
  • A dedicated robot that is attached to the primary hub if a robot without UMP does not exist. For more information, see the Deploy Robots article.
  • (
    MySQL Only
    ) If you are using MySQL for your CA UIM database, change the following default settings for your MySQL database 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 robot, and UMP robot must have Windows operating systems. There are no requirements for matching operating systems if you are NOT using Microsoft SQL Server Windows Authentication.
Hardware Requirements for CABI Server
  Ensure that your robot for CABI Server meets the following minimum hardware requirements:
  • 10-GB free disk space
  • 8-GB memory
  • Four 2-GHz CPUs
Deployment Configuration for CABI Server in a CA UIM Environment
Install CABI Server on a robot that is connected directly to the primary hub.
Do not deploy CABI Server on a robot running UMP or on a secondary hub.
The separate robot is required to avoid scale and performance issues. CABI Server is deployed through the cabi probe.
Do not install CABI server on a robot that is connected to a secondary hub or on a robot running UMP. These configurations are not supported.
The following figure shows the supported deployment configuration to add CABI to a CA UIM environment.
CA UIM with CABI Deployment Diagram
CA UIM with CABI Deployment Diagram
Determine Deployment Process
Use the following flowchart to determine which deployment process is required for your CA UIM environment.
cabi flow
cabi flow
First Time CABI Server Installation on a New UIM Server
Use this procedure to install a new CABI Server in a new CA UIM environment.
Process Overview
The following diagram shows the sequence of tasks to complete.
New Install Flow CABI
New Install Flow CABI
(Optional) Change the Default CABI Server Port
Only follow these steps if port 80 is not available on the robot, or a non-standard http port is desired. Use the following steps to change the default CABI server port value.
  1. Deploy wasp to the CABI Server robot if wasp is not currently installed.
  2. Edit the wasp probe on the CABI Server robot using Raw Configure.
  3. Select setup
  4. Edit the http_port key value and update your configuration. A "Failed to restart probe" error message, appears.
  5. Select
    Cancel
    to close the window.
  6. Do NOT restart wasp.
    The cabi probe installation restarts wasp.
  7. Verify your change in raw configure for wasp.
(Microsoft SQL Server Windows Authentication Only) Set up Windows Authentication for CABI
If you are using Microsoft SQL Server with Windows authentication, CABI cannot function until you configure Windows authentication on the CABI Server. Windows authentication must be set up in CA UIM, UMP, and CABI.
Follow these steps:
  1. On the robot for CABI Server, 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 CABI Server robot.
Deploy the cabi Probe
During deployment, the cabi probe installs and configures an instance of CABI Server on a CA UIM robot.
Follow these steps:
  1. Verify that the cabi probe, uim_core_dashboards_pack, and report packages are in the archive.
  2. Deploy the cabi probe package 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.
    Warning!
    During the cabi probe package configuration, wasp restarts on the robot with CABI Server. The deployment can take approximately 10 to 20 minutes to complete.
    Do not attempt to restart wasp before the deployment is complete.
    If you try to restart wasp before the deployment is complete, CABI Server will not install successfully.
  3. Verify that the CABI installation is complete. The cabi probe might be active, but the installation process might not be complete. Go to the cabi probe log file and look for the following messages:
    <
    date_time
    > [main, cabi] cabi installed successfully.
    ...
    ...
    ...
    <
    date_time
    > [UserSynchronizationThread, cabi] Finished synchronizing users between UIM and CABI
    During installation, the cabi probe uploads the DataSource, domain, topic, and users. The uim_core_dashboards_pack and report packages are also deployed with the probe.
    The wasp probe automatically starts when the process is complete.
Change the Default CABI Credentials
A default superuser account exists in CABI Server. You must change the credentials to maintain system security. You can use the superuser account to manage server settings.
Change the default username and password as soon as possible to maintain system security.
Follow these steps:
  1. Enter in a browser: 
    http://<CABI_Server_IP or hostname>:<port>/cabijs
    Where
    <port>
    is the port for the robot running wasp and CABI Server. The default port number is 80. For example,
    http://12.123.123.12:80/cabijs
    .
  2. Enter the default username and password for CABI Server. The default username and password is superuser.
  3.  Select Manage, Users to view the Users list.
  4. Select and edit the superuser entry to change the password.
Deploy the ump_cabi Portlet
Use this procedure to deploy the ump_cabi portlet package to view the predefined CABI dashboards in UMP.
Follow these steps:
  1. On the robot running UMP, deploy the most current version of the
    ump_cabi
    package.
  2. Verify that you can view the predefined dashboards. Go to the
    Unified Dashboards
    menu in UMP and select a CA Business Intelligence dashboard. For example,
    Unified Dashboards, CA Business Intelligence, Summary Dashboard
    .
New packages for predefined reports and dashboards are released periodically. For more information about adding updates to your dashboards, see Add New or Update Predefined CA Business Intelligence Dashboard Content.
First Time CABI Server Installation on an Upgraded UIM Server
These instructions detail how to deploy CABI Server into an Upgraded CA UIM environment for the first time.
Process Overview
The following diagram shows the sequence of tasks to complete.
CABI Process flow - new server on upgrade UIM
CABI Process flow - new server on upgrade UIM
(Optional) Change the Default CABI Server Port
Only follow these steps if port 80 is not available on the robot, or a non-standard http port is desired. Use the following steps to change the default CABI Server port value.
  1. Deploy wasp to the CABI Server robot if wasp is not currently installed.
  2. Edit the wasp probe on the CABI Server robot using Raw Configure.
  3. Select setup
  4. Edit the http_port key value and update your configuration. A "Failed to restart probe" error message, appears.
  5. Select
    Cancel
    to close the window.
  6. Do NOT restart wasp.
    The cabi probe installation restarts wasp.
  7. Verify your change in raw configure for wasp.
(Microsoft SQL Server Windows Authentication Only) Set up Windows Authentication for CABI
If you are using Microsoft SQL Server with Windows authentication, CABI cannot function until you configure Windows authentication on the CABI Server. Windows authentication must be set up in CA UIM, UMP, and CABI.
Follow these steps:
  1. On the robot for CABI Server, 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 CABI Server robot.
Deploy the cabi Probe
During deployment, the cabi probe installs and configures an instance of CABI Server on a CA UIM robot.
Follow these steps:
  1. Verify that the cabi probe, uim_core_dashboards_pack, and report packages are in the archive.
  2. Deploy the cabi probe package on a robot. For more information about how to deploy a probe package, see the Deploy Packages article.
    Warning!
    During the cabi probe package deployment, wasp restarts on the robot with CABI Server. The deployment can take approximately 10 to 20 minutes to complete.
    Do not attempt to restart wasp before the deployment is complete.
    If you try to restart wasp before the deployment is complete, CABI Server will not install successfully.
  3. Verify that the CABI Server installation is complete. The cabi probe might be active, but the installation process might not be complete. Go to the cabi probe log file and look for the following messages:
    <
    date_time
    > [main, cabi] cabi installed successfully.
    ...
    ...
    ...
    <
    date_time
    > [UserSynchronizationThread, cabi] Finished synchronizing users between UIM and CABI
    During installation, the cabi probe uploads the DataSource, domain, topic, and users. The uim_core_dashboards_pack and report packages are also deployed with the probe.The wasp probe automatically starts when the process is complete.
Change the Default CABI Credentials
A default superuser account exists in CABI Server. You must change the credentials to maintain system security. You can use the superuser account to manage server settings.
Change the default username and password as soon as possible to maintain system security.
Follow these steps:
  1. Enter in a browser: 
    http://<CABI_Server_IP or hostname>:<port>/cabijs
    Where
    <port>
    is the port for the robot running wasp and CABI Server. The default port number is 80. For example,
    http://12.123.123.12:80/cabijs
    .
  2. Enter the default username and password for CABI Server. The default username and password is superuser.
  3.  Select Manage, Users to view the Users list.
  4. Select and edit the superuser entry to change the password.
Deploy the ump_cabi Portlet
Use this procedure to deploy the ump_cabi portlet package to view the predefined CABI dashboards in UMP.
Follow these steps:
  1. On the robot running UMP, deploy the most current version of the
    ump_cabi
    package.
  2. Verify that you can view the predefined dashboards. Go to the
    Unified Dashboards
    menu in UMP and select a CA Business Intelligence dashboard. For example,
    Unified Dashboards, CA Business Intelligence, Summary Dashboard
    .
Update the Unified Dashboards Menu
During upgrade, the Liferay Archive (LAR) files that generate the Unified Dashboard menu items in UMP are not updated. This process preserves any customizations that you have made to your LAR files. Use this procedure to update the Unified Dashboards menu for a user or a user group whenever there is a new release of UMP.
Follow these steps:
  1. Download the cabi.lar file to your local system. Obtain the current LAR file from the UMP robot filesystem at:
    <
    UIM_installation
    >/probes/service/wasp/webapps/cabi/lar/cabi.lar
  2. Log in to UMP as an administrator.
  3. Click
    Go to, Control Panel
    on the menu bar.
  4. Click
    My Pages
    , and then click
    Private Pages
    .
  5. Click
    Import
    and select the LAR file.
  6. Expand the Unified Dashboards node in the Private Pages tree and verify that the list contains CA Business Intelligence Dashboards.
    Example My Pages Window
  7. Save your changes.
    The Unified Dashboard menu contains a section for the CA Business Intelligence dashboards.
    CA Business Intelligence Dashboard menu example
  8. Go to the
    Unified Dashboards
    menu and select a CA Business Intelligence dashboard. For example,
    Unified Dashboards, CA Business Intelligence, Summary Dashboard
    .
New packages for predefined reports and dashboards are released periodically. For more information about adding updates to your dashboards, see Add New or Update Predefined CA Business Intelligence Dashboard Content.
Upgrade CABI Server
The instructions in this section are for users that have already deployed CABI Server and want to complete an upgrade.
Process Overview
The following diagram shows the sequence of tasks to complete.
cabi process flow - upgrade
cabi process flow - upgrade
Redeploy the cabi Probe
To upgrade CABI Server, redeploy the latest version of the cabi probe. 
 
Follow these steps:
  1. Verify that the cabi probe, uim_core_dashboards_pack, and report packages are in the archive.
  2. Deploy the latest cabi probe package to the location of your existing cabi probe. 
    For more information about how to deploy a probe package, see the Deploy Packages article.
    Warning!
    During the cabi probe package deployment, wasp restarts on the robot with CABI Server. The deployment can take approximately 10 to 20 minutes to complete.
    Do not attempt to restart wasp before the deployment is complete.
    If you try to restart wasp before the deployment is complete, CABI Server will not install successfully.
  3. Verify that the CABI Server installation is complete. Go to the cabi 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
    The wasp probe automatically starts when the process is complete.
Deploy the ump_cabi Portlet
Use this procedure to deploy the ump_cabi portlet package to view the predefined CABI dashboards in UMP.
Follow these steps:
  1. On the robot running UMP, deploy the most current version of the
    ump_cabi
    package.
  2. Verify that you can view the predefined dashboards. Go to the
    Unified Dashboards
    menu in UMP and select a CA Business Intelligence dashboard. For example,
    Unified Dashboards, CA Business Intelligence, Summary Dashboard
    .
Update the Unified Dashboards Menu
During upgrade, the Liferay Archive (LAR) files that generate the Unified Dashboard menu items in UMP are not updated. This process preserves any customizations that you have made to your LAR files. Use this procedure to update the Unified Dashboards menu for a user or a user group whenever there is a new release of UMP.
Follow these steps:
  1. Download the cabi.lar file to your local system. Obtain the current LAR file at from the UMP robot filesystem at:
    <
    UIM_installation
    >/probes/service/wasp/webapps/cabi/lar/cabi.lar
  2. Log in to UMP as an administrator.
  3. Click 
    Go to, Control Panel
     on the menu bar.
  4. Click 
    My Pages
    , and then click 
    Private Pages
    .
  5. Click 
    Import
     and select the LAR file.
  6. Expand the Unified Dashboards node in the Private Pages tree and verify that the list contains CA Business Intelligence Dashboards.
    Example My Pages Window
  7. Save your changes.
  8. Clear your browser cache.
    The Unified Dashboard menu contains a section for the CA Business Intelligence dashboards.
    CA Business Intelligence Dashboard menu example
  9. Go to the
    Unified Dashboards
    menu and select a CA Business Intelligence dashboard. For example,
    Unified Dashboards, CA Business Intelligence, Summary Dashboard
    .
New packages for predefined reports and dashboards are released periodically. For more information about adding updates to your dashboards, see Add New or Update Predefined CA Business Intelligence Dashboard Content.
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.
Upgrade Pre-existing Self-signed Certificates to Java 1.8
Perform this procedure if your version of CABI was previously configured to use HTTPS. The Java version was updated to Java 1.8 starting with CA UIM version 8.5.1. You must upgrade any self-signed certificates that are generated by CA UIM from previous CA UIM versions. If you do not upgrade the pre-existing certificates, HTTPS connections to CABI Server will not work due to the change in security encryption levels in Java 1.8.
Follow these steps:
  1. Repeat the following steps for each instance of wasp that you configured for HTTPS.
  2. On the CABI Server robot with wasp, navigate to the wasp.keystore file in
    <UIM_installation>\probes\service\wasp\conf\wasp.keystore.
  3. Delete the wasp.keystore file.
  4. Go to Admin Console.
  5. Restart wasp on the CABI Server robot. The wasp.keystore file is regenerated according to the SHA256 algorithm standard.
  6. Verify that you can reestablish browser connectivity to the system. Accept any prompts to accept the new self-signed certificate in your browser.
Using an External URL to Access CABI Server
Use this procedure if you are an MSP that requires your customers to connect through an external URL to access the dashboards.
Follow these steps:
  1. Obtain the Fully Qualified Domain Name (FQDN) for the external URL.
  2. Go to the filesystem on the CABI Server.
  3. Edit the hosts file. The location depends on the platform type:
    • Windows -
      c:\windows\system32\drivers\etc\hosts
    • Linux -
      /etc/hosts
  4. Add an entry with the syntax:
    <local IP of the cabi server> <FQDN of external url>
    For example,
  5. Save the file.
  6. Open raw configure for the cabi probe.
  7. Go to
    Setup
    and add the key
    cabi_url
    with the value:
    http://<FQDN of external url>/cabijs
  8. Restart the cabi probe and wait for the new port and pid before continuing with the next step. In cabi.log, the new path pointing to the FQDN URL appears.
  9. Restart wasp on the UMP robot.
  10. You can access CABI Server using the new FQDN and the UMP cabi dashboards resolve for the new URL.
If using https, follow the instructions in Configure CABI Server to Use HTTPS.
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 UMP as described in the article Configure HTTPS in Admin Console or UMP.
  2. Go to the robot running wasp and CABI Server.
  3. Configure wasp for HTTPS as described in the article Configure HTTPS in Admin Console or UMP.
  4. Open raw configure for the cabi probe.
  5. Go to
    Setup
    and add the key
    cabi_url
    with the value:
    https://<CABI_Server_IP or hostname>:<port>/cabijs
    Where
    <port>
    is the HTTPS port.
  6. Restart wasp on the UMP robot.
  7. Instruct users who access CABI Server directly to use the URL: 
    https://<CABI_Server_IP or hostname>:<port>/cabijs
    Where
    <port>
    is the port for https communications. The default HTTPS port number is 8443. For example,
    https://12.123.123.12:8443/cabijs
    .
  8. 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 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 probe and dashboards.
Follow these steps:
  1. Go to raw configure for the cabi probe.
  2. Set the value for the following keys as needed:  
    • auto_backup_fequency_in_hours - The cabi 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 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 is the amount of time allowed to pass before an error message is generated in the cabi probe log file. The default setting is
      1800
      seconds.
Bundled CABI Server Firewall Rules
The following table defines the ports and directions that must be open through a firewall for a Bundled configuration. For additional information, see Firewall Port Reference.
Communication Required
Ports
Direction
Firewall Rules
Details
Bundled CABI Server to UIM database
1433 (Microsoft SQL Server);
1521 (Oracle);
3306 (MySQL)
Inbound
Allow inbound on respective port for UIM database.
 Inbound from CABI Server to the chosen database. The port depends on the database type and configuration.
Bundled CABI Server to UMP
80 or 443; configurable
Inbound, outbound
Allow inbound on 80 or 443 to UMP and CABI Server.
This connection provides browser and customer client connectivity to CABI Server and UMP. Port 80 by default or port 443 for HTTPS. You can use another configured port value for HTTP or HTTPS. The port can vary from client/browser to CABI Server and UMP. The value depends on your choice during the CABI Server and UMP installation. For example, port 80 or port 443. The configurable range of ports is 1 through 65535.