Skip to content
CA Unified Infrastructure Management Probes
Documentation powered by DocOps

CA Business Intelligence Dashboards

Last update December 5, 2017

The CA Business Intelligence (CABI) dashboards in CA Unified Infrastructure Management (UIM), are predefined dashboards that you can access from the Unified Dashboards menu. These dashboards contain multiple reports (dashlets) that rely on CA UIM probes for data. Each dashboard provides an integrated view of related content.

Contents

Install the Dashboards

The dashboards are not available by default. For more information about installation and user permissions, see the Install CA Business Intelligence (CABI) Server article for your CA UIM version.

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.

Install or Upgrade CA Business Intelligence Server articles:

Add Data to a Dashboard

The dashboards rely on CA UIM probes for data. The monitoring probe that populates a dashboard with data must be successfully installed and configured.

For more information about how to install and configure a specific probe, see the Alphabetical Probe Articles. The probe metrics article describes what metrics must be enabled to populate a default dashboard with data.

Access CABI Server

You typically access CABI Server to create custom dashboards.

Note: A user can only log directly in to CABI Server if an administrator or superuser has set a password for their user account in CABI.

  • CABI Server on CA UIM robot by cabi probe (Bundled).
    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. An example of a URL is, http://12.123.123.12:80/cabijs.
  • CABI Server NOT installed on CA UIM robot by cabi probe (External).
    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.

User Accounts for 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 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 when a user is created directly within CABI Server.

Using CABI Superuser

A default superuser account exists in CABI Server. Before you change 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.

Permissions for 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 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 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.

Important! Do not modify the CABI_REST_ USER account in CABI Server. This account is required to synchronize users, roles, and organizations in CABI Server.

CABI Portlet Actions

Depending on your CA UIM version, the following actions might be available in a CABI portlet.

Edit Dashboard: Click the Edit Dashboard icon to open CABI Server: Dashboard Designer.

Filters: Click the Filters drop-down list to view the filters that are associated with a dashboard. Filters allow you to sort the information that appears in your view. Different options are available based on the dashboard. In a multi-tenant environment, you can view data for all the origins you have permissions to view. Your permissions can affect the data that appears in a summary view and the available options for filters.

Reports: (cabi probe version 3.20 and later) Click the Reports drop-down list to view the reports you can run from a dashboard. For more information about specific reports, see Library of CA Business Intelligence Reports for CA UIM.

Help: Click the Question-mark icon to view additional information about a dashboard.

Home: Click the Home icon to return to the Summary Dashboard.

View Fullscreen: Click the View Fullscreen icon to view a dashboard in full-screen mode.

Dashboard Actions

Various charts and graphs appear within each dashboard. The following actions might be available in a dashboard or dashlet.

Chart or Graph Legend: Select items in the chart or graph legend to hide a specific group of data.

Chart Types (Chart Types icon): Click to select a chart type.

Export (Export icon): (cabi probe version 2.0 and later) Click to export the content to the selected output.

Hover: Hover your mouse over dashboard charts and graphs to view specific data points.

Links (example link): Click to view additional information.

Maximize (Maximize icon): Click to open the dashlet in a larger view.

Minimize (minimize icon): Click to return to the dashboard view.

Refresh (Refresh icon): Click to refresh the dashlet contents.

Summary Report (example summary report): Click to view more detailed information. Some summary reports contain specific areas that are links to more detailed information. For example, alarms.

Alarm Icons

The following icons for alarms might appear in some dashboards.

  • Critical Critical alarm icon
  • Major Major alarm icon
  • Minor Minor alarm icon
  • WarningWarning alarm icon
  • Info Info alarm icon
  • Clear Clear alarm icon

(Optional) Create a Custom Dashboard

The dashboards contain many predefined reports (dashlets). If the predefined information does not meet your needs, you can create a custom report. You create custom dashboards in CABI Server. For more information, see the TIBCO JasperReports Server User Guide.

 Follow these steps:

  1. Go to the CABI Server home page.
  2. Create an Ad Hoc view, if you want to create a report.
    • To create a view for alarms, devices, or groups, select UIM Domain.
    • To create a view for a single metric, select UIM Single QoS Topic.
    • To create a view with data from multiple metrics and devices, select UIM Metric Topic.
  3. Create a report from the Ad Hoc view.

    Important! Do not add Ad Hoc Views directly to dashboards. This practice can lead to performance and memory issues.


  4. Create a CABI dashboard and add the report. The dashboard can then be incorporated into UMP through the CABI portlet.

(Optional) Add a Custom Dashboard to UMP 

Each custom dashboard must be added to UMP using a separate instance of the CABI portlet.

Note: Depending on the dashboards you create, you might need to activate more monitors in the corresponding probe to provide data.

Follow these steps:

  1. Log in to UMP.

  2. Add a page for the CABI portlet. For more information, see the article on adding and deleting pages and portlets for your CA UIM version.
  3. Add the CABI portlet to the page. The CABI portlet is located under Monitoring. For more information, see the article on adding and deleting pages and portlets for your CA UIM version.
  4. Click Options, Preferences.
  5. Provide the following CABI Server connection information: 
    • Dashboard Path: The full address of the dashboard you want to add. The dashboard path is found in CABI Server. Locate the existing dashboards in CABI Server by selecting View, Repository. The dashboards are located in the "Folders" column. For example, /public/ca/uim/dashboards/aws/aws_summary. Right-click the dashboard in CABI Server and select Properties to see the path.
    • (Optional) Dashboard Filters: It is not necessary to change dashboard filters. The predefined dashboards are already configured with the appropriate filters for the dashboard. In CABI Dashboard Designer, you must manually create a filter. For more information about dashboard filters, refer to the CABI Server help.
      • A fixed dashboard filter defines the initial input parameters for the dashboard. The format is filter name then the array of filter values.
        Examples:
        • To collect data from the aws and vmware probes in a dashboard, enter {'prid':['aws','vmware']}.
        • To collect data in a dashlet for a specific device, enter {'cs_id':['6']}.
      • Dynamic filters can be used to add additional filtering that is defined in Jasper Report input controls. For example, add additional device by roles filters. You must create a Jasper Report input control in CABI Server to use reference with this filter.
  6. Repeat these steps for each dashboard that you want to add.
  7. Click Return to Full Page.

FAQs

What files do I need to send to support if I experience issues with CA Business Intelligence Dashboards?

There are multiple files to send to support. In some instances, multiple versions of a file might exist due to date and timestamps. Send the most current file from the following locations:

  1. Go to the file system of the robot where the cabi probe is installed.
  2. Copy the following files depending on your UIM version.
    • CA UIM version 8.5.1:
      • Go to <UIM_installation>\c and copy upgrade.properties_<date_time>.
        For example, upgrade.properties_2017-01-24_09-57-02-223
      • Go to <UIM_installation>\c\ca_install and copy all the files in the directory that follow the format uim.<filename>.
        For example, uim.log, uim.properties, and uim.log_2017-01-24_09-57-02-223
    • CA UIM version 8.5 and earlier:
      • Go to <UIM_installation>\cabi and copy upgrade.properties_<date_time>.
        For example, upgrade.properties_2017-01-24_09-57-02-223
      • Go to <UIM_installation>\cabi\ca_install and copy all the files in the directory that follow the format uim.<filename>.
        For example, uim.log, uim.properties, and uim.log_2017-01-24_09-57-02-223
  3. Go to <UIM_installation>\probes\service\cabi
  4. Copy the following files for the cabi probe:
    • _cabi.log
    • cabi.log
    • cabi_install_archive.log
    • cabi.cfg
    • content (Copy the entire directory.)
  5. Go to Admin console and view the primary hub robot.
  6. Expand the data_engine menu and click View Config File.
  7. Download data_engine.cfg.
  8. Expand the data_engine menu and click View View Probe Utility in New Window.
  9. Run the command get_connection _string.
  10. Export the output to a CSV file.

Where are the default CA UIM dashboards located in the CABI Server repository?

The installed dashboards are located in /public/ca/uim.

Why do I see an "Error: Could not find cabi probe." message when I open the dashboard portlet?

The portlet cannot find the cabi probe. Verify that the probe is installed. If the issue still exists:

  1. Open wasp in Raw Config on the UMP robot.
  2. Go to the setup section.
  3. Add the key: cabi
  4. Add the path to the cabi probe as the value. The path uses the format: /<domain_name>/<hub_name>/<robot_name>/cabi
  5. Save the changes and restart wasp.

What do I do when I see a No dashboard found with path error?

The CA Business Intelligence Dashboards fail to load if you select a dashboard in the Unified dashboards menu. If you go to a dashboard and select Options, Preferences, the portlet has the correct CABI URL. The format of the URL to CABI Server is http://<CABI_Server_IP or hostname>:<port>/cabijs.

The following figure shows an example of the error message and a correct CABI Server URL.
Image of portlet and path

If you view the portlet using the developer tools in your browser, you also see an error. The following image is an example of the error message in Chrome.
Image of Chrome error

To resolve this issue, add a third-party site data exception in the browser settings. Use the IP or hostname of the system that is hosting the cabi probe.

Can I create my own dashboards and reports?

You can create your own dashboards and reports using the commercial edition of Jaspersoft Studio. This software is not provided with the CABI for UIM Dashboards. You can download a trial version of the software from the Download Jaspersoft Business Intelligence Suite page. To complete the installation, you must copy and then import the jasperserver.license file into Jaspersoft Studio. The jasperserver.license file is located in <Nimsoft>\probes\service\cabi\cabi.

Why do I see a "CABI is temporarily unavailable." message when I select a dashboard?

This message appears if the CABI installation is not complete for your CA UIM deployment. You must deploy the cabi probe. For more information, see the Install CA Business Intelligence (CABI) Server article for your CA UIM version.

Why do I see a "No data found for alarms" message in my dashboard?

No alarms have been generated to view.

Why do I see a "QOS_Name is not defined" message in my dashboard?

The specified QoS must be activated in the probe configuration.

What do I do if my dashboards are not rendering?

Refresh your browser window. If your dashboards are still not rendering, verify that you have successfully installed the dashboards.

Can account contact user administrators create an Ad Hoc View while their origin contains no inventory data?

No, the inventory must exist for the origin. A cache error is generated if no inventory exists.

I modified the CABI_REST_ USER account in CABI Server. Why is information for my users, roles, and organizations no longer being synchronized in CABI Server?

You should not modify the CABI_REST_ USER account in CABI. There are two possible recovery processes:

  • In the CABI Server interface, change the superuser account back to superuser (default account settings).
  • In the raw config setup keys for the cabi probe, set the recovery_username and recovery_password values to the new superuser password. Restart the cabi probe.

Wait for the CABI_REST_ USER account to be recreated in CABI Server. Then reset the default superuser credentials.

Why did I lose access to the CABI Server GUI when I removed wasp from the robot running CABI Server?

CABI is a web-based application. Wasp provides the web-server that serves up web applications.

How do I export multiple dashboards?

To export dashboards, see Import and Export.

Where can I find more information about CA Business Intelligence JasperReports Server?

For more information, see CA Business Intelligence and TIBCO Jaspersoft Studio Documentation.

Descriptions of Dashboards and Reports

For more information about specific dashboards and reports, see the following articles.


Was this helpful?

Please log in to post comments.

  1. Alquin Gayle
    2017-11-16 10:51

    To collect data in a dashlet for a specific device, enter {'cs_id':['6'].

    The line above is missing the closing } if should be To collect data in a dashlet for a specific device, enter {'cs_id':['6']}.

    If you could add more examples of filters that can be used it would be a great help as well.

    1. Medikonda, Sandeep Samuel
      2017-12-05 02:58

      This is fixed and will be available in the next publish.

      -Documentation Team

  2. Daniel Blanco
    2018-01-26 03:34

    is it possible to run the cabi probe in https mode?

    1. Medikonda, Sandeep Samuel
      2018-03-09 03:41

      Hi Daniel Blanco, you can configure the cabi server to use HTTPS. Review this article Configure CABI Server to Use HTTPS.

      -Documentation Team

  3. Adrien Stozicky
    2018-05-03 12:44

    About the Export option in the Dashboard Actions section could you add a list of the export formats? (PDF, Excel, RTF, CSV, ODT, ODS,DOCX, XLSX,PPTX) Would be easier than to have to look directly on the Dashboards. Thanks

    1. Medikonda, Sandeep Samuel
      2018-05-03 11:53

      Sure Adrien Stozicky, we'll make this available for our next refresh.

      -Documentation Team.