Skip to content
CA Unified Infrastructure Management - 8.5
Documentation powered by DocOps

Install or Upgrade CA Business Intelligence with CA UIM

Last update November 27, 2017

The CA Business Intelligence (CABI) dashboards within CA Unified Infrastructure Management (CA UIM) use CABI Server. CABI provides rich reporting and integrates in-memory analysis capabilities. The dashboards are not available by default when you install CA UIM. You must install CABI Server.

You can use the following flowchart to determine the deployment method required for your CA UIM environment.

cabi flow

Contents


Verify Prerequisites

For a complete list of dependencies, requirements, and known issues, see CA Business Intelligence Dashboards Release Notes.

Environment Requirements

The CABI for UIM requires the following components:

  • CABI is supported on all platforms, operating systems, and databases that are supported by UIM server and UMP. For more information about supported platforms, refer to the CA UIM Support Matrix (login required).
  • (Microsoft SQL Server Windows Authentication Only) The CABI Server robot and UMP robot must have Windows operating systems.
  • Install or upgrade to CA UIM version 8.5. For more information, see the following articles:
  • Deploy a new robot on the primary hub if a robot without UMP does not exist. The minimum robot version is 7.80. For more information, see the Deploy Robots article.

Hardware Requirements for CABI Server

  Ensure that your robot with CABI server meets the following minimum hardware requirements:

  • 10-GB free disk space
  • 8-GB memory
  • Four 2-GHz CPUs

Deployment Configuration for CABI in a CA UIM Environment

You must install CABI server on a robot connected directly to the primary hub. Do not deploy CABI server on a robot running UMP or on a secondary hub. A separate robot is required to avoid scale and performance issues. CABI server is deployed through the cabi probe. The ump_cabi package is automatically installed with UMP.

Important! Do not install CABI server on a robot connected to a secondary hub. This configuration is not supported.

The following figure shows the supported deployment configuration to add CABI to a CA UIM environment.

CA UIM with CABI Deployment Diagram

CABI Server Firewall Rules

The following table defines the ports and directions that must be open through a firewall for CABI Server. For additional information, see Firewall Port Reference.

CA UIM Component Ports Direction Firewall Rules Details
CABI Server, UIM database

1433, 1521 or 3306

Inbound Allow inbound on respective port to database server.  Inbound from CABI Server to the chosen database.
CABI Server, 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 or another configured port for 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.

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

New Install Flow CABI

Install CABI Server

Warning! During the cabi probe package deployment, wasp restarts. 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 might not install successfully.

 Follow these steps:

  1. Review the information in the CABI Release Notes.
  2. Verify that your CA UIM implementation meets the environment and hardware requirements for CABI Server.
  3. (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 will restart wasp.
    7. Verify your change in raw configure for wasp.

  4. Deploy the cabi probe package according to the Deployment Configuration for CABI in a CA UIM Environment section in this article. The cabi probe package installs CABI Server, wasp (if not previously installed), and updates the CA UIM database.
    For more information about how to deploy a probe package, see the Deploy Packages article.

  5. Verify that the CABI installation is complete. Go to the cabi probe log file and look for the following message:

    [UserSynchronizationThread, cabi] Finished synchronizing users between UIM and CABI

    During installation, the cabi probe uploads the DataSource, domain, topic, and users. The wasp probe automatically starts when the process is complete.

  6. (Microsoft SQL Server Windows Authentication Only) Set up Windows Authentication for CABI.

    Important! 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.

    1. On the CABI robot, go to Administrative Tools > Services and double-click on Nimsoft Robot Watcher.
    2. Select the Log On tab.
    3. Change the logon account to the same account and password 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 robot.

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.

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.

    Important! Change the default username and password as soon as possible to maintain system security.

  3.  Select Manage, Users to view the Users list.
  4. Select and edit the superuser entry to change the password.

First Time CABI Server Installation on an Upgraded UIM Server

These instructions detail how to deploy a new CABI server into an Upgraded CA UIM environment.

Process Overview

CABI Process flow - new server on upgrade UIM

Install CABI Server

Warning! During the cabi probe package deployment, wasp restarts. 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 might not install successfully.

 Follow these steps:

  1. Review the information in the CA Business Intelligence Dashboards Release Notes.
  2. Verify that your CA UIM implementation meets the environment and hardware requirements for CABI Server.
  3. (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 will restart wasp.
    7. Verify your change in raw configure for wasp.

  4. Deploy the cabi probe package according to the Deployment Configuration for CABI in a CA UIM Environment section in this article. The cabi probe package installs CABI Server, wasp (if not previously installed), and updates the CA UIM database.
    For more information about how to deploy a probe package, see the Deploy Packages article.

  5. Verify that the CABI installation is complete. Go to the cabi probe log file and look for the following message:

    [UserSynchronizationThread, cabi] Finished synchronizing users between UIM and CABI

    During installation, the cabi probe uploads the DataSource, domain, topic, and users. The wasp probe automatically starts when the process is complete.

  6. (Microsoft SQL Server Windows Authentication Only) Set up Windows Authentication for CABI.

    Important! 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.

    1. On the CABI robot, go to Administrative Tools > Services and double-click on Nimsoft Robot Watcher.
    2. Select the Log On tab.
    3. Change the logon account to the same account and password 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 robot.

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.

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.

    Important! Change the default username and password as soon as possible to maintain system security.

  3.  Select Manage, Users to view the Users list.
  4. Select and edit the superuser entry to change the password.

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 preserves any customizations that you have made to your LAR files. Use this procedure to manually 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 following LAR file to your local system:
    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.
  7. Save your changes.
    The CA Business Intelligence dashboards appear in the Unified Dashboard menu for authorized users.

Upgrade CABI Server

The instructions in this section are for users that have already deployed a CABI server and want to complete an upgrade.

Process Overview

cabi process flow - upgrade

Redeploy the cabi Probe

To upgrade the CABI server, redeploy the latest version of the cabi probe. 

 Follow these steps:

  1. 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. 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 might not install successfully.

  2. Verify that the CABI installation is complete. Go to the cabi probe log file and look for the following message:

    [UserSynchronizationThread, cabi] Finished synchronizing users between UIM and CABI

    During upgrade, the cabi probe updates the DataSource, domain, topic, and users. The wasp probe automatically starts when the process is complete.

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 preserves any customizations that you have made to your LAR files. Use this procedure to manually 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 following LAR file to your local system:
    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.
  7. Save your changes.
    The CA Business Intelligence dashboards appear in the Unified Dashboard menu for authorized users.

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 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. 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.
  7. Instruct users to accept any browser specific security certificate warnings required to proceed to the CABI Server home page.

Check for New Dashboards

New dashboards are released periodically, either as part of an UMP release or as a standalone package for individual probes. These updated dashboards are not automatically applied by CA UIM. To update dashboards with an existing UMP implementation, you must download the dashboards package from the CA UIM support site, and then deploy the package. Periodically check either the CA UIM support site or Admin Console Web Archive and update your dashboards as appropriate.

Follow these steps:

  1. Download the uim_<probe name>_dashboards_pack.zip package to the archive.
  2. Deploy the package to a robot running the cabi probe to update the dashboard information in CABI server.

Was this helpful?

Please log in to post comments.

  1. Chandresh Patel
    2017-01-16 09:19

    Hello,

    The Supported Configuration Diagram on this page suggests that the CABI server only requires a connection to the Primary Hub, however according to the firewall port reference at: https://docops.ca.com/ca-unified-infrastructure-management/8-5/en/installing-ca-uim/pre-installation-planning/firewall-port-reference

    The database has to allow an inbound connection from the CABI server, so the diagram could do with some clarification, either by way of a note linking to the port reference or an amended diagram to clarify that the connection is required.

    1. Cynthia Timko
      2017-01-17 12:54

      Hi Chandresh,

      Thanks for your feedback! We will take another look at this topic and make any necessary changes.