Install CA Business Intelligence with CA UIM

 
uim847
 
cabi_install
The CABI for UIM dashboards within CA Unified Infrastructure Management (CA UIM) use CA Business Intelligence (CABI) Server. CABI provides rich reporting and integrates in-memory analysis capabilities. This release ships predefined dashboards for supported probes and supports custom (Ad Hoc) reporting.
The dashboards are not available by default when you install CA UIM. You must install CABI Server.
Contents
Before You Begin 
Ensure that you have performed the following tasks before installing CABI.
Environment Requirements
The CABI for UIM requires the following components:
  • CABI for UIM dashboards 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.47. 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
  • Port 80 must be available
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. The following figure shows the supported deployment configuration to add CABI to a CA UIM environment.
Do not install CABI Server on a robot connected to a secondary hub. This configuration is not supported.
CA UIM with CABI Deployment Diagram
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.
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.
Deployment Overview
CABI Server Deployment
CABI Server Deployment
Install CABI Server
Use this procedure to install CABI Server.
 
Follow these steps:
  1. Review the information in the Before You Begin section of this article.
  2. Verify that your CA UIM implementation meets the environment and hardware requirements for CABI Server. The cabi probe package installs CABI Server, wasp and updates the CA UIM database.
  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. (
    Optional
    ) If you are using Microsoft SQL Server Windows Authentication, Set up Windows Authentication for CABI.
  5. Deploy the cabi probe package according to the Deployment Configuration for CABI in a CA UIM Environment section in this article.  
    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 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.
  6. 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.
(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 both in CA UIM, UMP, and CABI.
Follow these steps:
  1. After CABI Server is installed, go to
    Windows Services
    and select the tab for
    Change the Nimbus robot watcher services logon
    .
  2. Change the log in account to the same account used in the
    data_engine
    and the primary UIM server
    Nimbus robot watcher service
    .
  3. 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.
    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.
User Accounts for CABI for UIM Dashboards
Create and modify users through UMP in CA UIM. When a user is created in CA UIM, the same user is automatically created in CABI Server.
Users are not automatically deleted between CA UIM and CABI. When a user is deleted in CA UIM, the user still exists in CABI Server to preserve any reports that the user might have created. You must manually delete a user in CA UIM and then in CABI Server to completely remove the user. Because user permissions in CABI Server are inherited from CA UIM, a deleted CA UIM user would typically not have access to CABI Server. The exception to this rule is if a user is created directly within CABI Server.
Using CABI Superuser
A default superuser account exists in CABI Server. Before you make any changes to the CABI Server settings, use the export function in CABI Server to back up your default configuration. For more information, see the CABI help.
You can use the superuser account to:
  • Manage CABI Server settings
  • Configure custom data sources and domains
  • Delete users and organizations
  • Import and export reports
In general, do not use a superuser account to create users and organizations in CABI.
Permissions for CABI for UIM Dashboards
The data a user can view is determined by their CA UIM origin. For more information about the types of users and their permissions, see Types of Users.
To use the CABI for UIM dashboards, a CA UIM user must have the following ACL permissions:
  • List Viewer - To view reports
  • Report Designer - To edit and create dashboards and reports
The following accounts are set up in CABI as part of the CABI for UIM installation:
  • The CABI_REST_ USER has ROLE_ SUPERUSER and ROLE_ ADMINISTRATOR
  • Any CA UIM bus user (non-account user) has ROLE_ADMINISTRATOR and can manage users and reports within an organization.
Do not modify the CABI_REST_ USER account in CABI Server. This account is required to synchronize users, roles, and organizations in CABI Server.
(Optional) 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.