Install CA Business Intelligence Reports and Dashboards

You can install the standalone CABI integration and the Unified Dashboards and Reporting for Infrastructure Management solution.
You can install the following:
  • The
    CA Business Intelligence
    (CABI) reports and dashboards (a standalone CABI instance). Install the reports so that you can run them in
    NetOps Portal
    .
  • The Unified Dashboards and Reporting for Infrastructure Management solution. Install this solution so that you can integrate a single instance of CABI with other data sources.
    For more information about this solution, see Unified Dashboards and Reporting for Infrastructure Management.
Use the following process to install CABI reports and dashboards:
Verify the Prerequisites
Before setting up and running CABI reports in
NetOps Portal
, verify that you have completed the following:
  • You have installed CABI JasperReports Server and it is available.
  • (For CABI on Windows) You have enabled Powershell.
Install Reports on the
CA Business Intelligence
JasperReports Server
To make CABI reports that use
DX NetOps Performance Management
data available, install them on the CABI JasperReports Server.
DX NetOps Performance Management
content is delivered through a connector for the CABI JasperReports Server.
The
DX NetOps Performance Management
installation includes the
<installation_directory>/
PerformanceCenter/cabi/capm_reports-xxxx.zip
file (where "xxxx" is the package version). You can use this installation script for a fresh installation or an upgrade.
The script covers the following items:
  • Data source connector files
  • Data source connector configuration
  • NetOps Portal
    host name, port, and schema definition
  • Report files
  • Dasboard/dashlets files
  • Common folder structure to use in Shared CABI environment
The script does not include user administration and authentication setting updates. You must configure these manually.
Follow these steps:
  1. Copy the
    capm_reports-xxxx.zip
    file to the CABI JasperReports Server host and unpack it into a directory for the reports.
    Ensure that the
    capm_topn-x.x.x.zip
    report archive file and the
    capm_da-x.x.x.zip
    data source archive file are in the same directory on the CABI JasperReports Server as the installation scripts.
  2. Run the
    Install.bat
    (Windows) or
    Install.sh
    (Unix) installation script.
    The
    DX NetOps Performance Management
    -CABI content installation requires a CABI Tomcat instance restart. The CABI web interface is unavailable for approximately 10-15 minutes after the installation start. Ensure that the installation process is done during an appropriate maintenance window.
  3. Complete the following prompts:
    • Input a
      NetOps Portal
      target host
      Specify the
      NetOps Portal
      host name.
    • Input the
      NetOps Portal
      GUID
      This prompt appears only when the installer cannot connect to the
      NetOps Portal
      server and get the GUID automatically.
      The installation uses the
      NetOps Portal
      GUID (unique) as the default password. The GUID passes to the data aggregator to ensure that the request is going to the correct
      NetOps Portal
      instance.
      You can retrieve this information by accessing the
      datasources
      NetOps Portal
      REST web service. Enter the following URL in a browser:
      http://
      <NetOps_Portal_hostname>
      :8181/pc/center/webservice/datasources/{idName}
      Example Response:
      <dataSourceGUID name="NetOps Portal" guid="
      66750a6b-57f6-440e-b501-d79134d9bb61
      "/>
      For more information about this web service, see Data Sources Web Service.
    • Input a target
      NetOps Portal
      port [8181]
      Specify the
      NetOps Portal
      port number. For example, if HTTPS is enabled for
      NetOps Portal
      , enter 8182.
      Default:
      8181
    • Input a target schema http/https [http]
      Specify the protocol for the connection to
      NetOps Portal
      . Accept the default, or if HTTPS is enabled for
      NetOps Portal
      , enter
      https
      .
      Default:
      http
    • CA PC admin user [admin]
      Specify the
      NetOps Portal
      admin user.
      Default:
      admin
    • CA PC admin user password [admin]
      Specify the password for the
      NetOps Portal
      admin user.
      Default:
      admin
    The script can take up to 10 minutes to complete the installation.
  4. Configure the values that are required for generating the OpenAPI token by opening and editing the
    CABIJasperReportsServer
    /WEB-INF/bundlescapc_config.properties
    file:
    These values must match the
    cookieName
    ,
    tokenEncryptionDecryptionKey
    , and
    tokenTimeoutInMinutes
    parameter values on the data aggregator that are in the
    <installation_directory>/IMDataAggregator
    /
    apache-karaf-*
    /etc/com.ca.im.odata.authservice.impl.AuthenticationService.cfg
    directory.
    • installation_directory
      The installation directory for the data aggregator.
      Default:
      /opt
    • apache-karaf-*
      The installation directory for Apache Karaf.
      Example:
      apache-karaf-4.2.6
    • openAPIcookieName
      The name of the cookie containing the token. This value should match the
      cookieName
      value.
    • encryptionKey
      The key that is used to decrypt incoming tokens. This value should match the
      tokenEncryptionDecryptionKey
      value.
    • tokenTimeout
      The length of time, after which, the token is invalidated. This value should match the
      tokenTimeoutInMinutes
      value.
Configure User Synchronization
When you integrate
DX NetOps Performance Management
with CABI, you create and manage users in
NetOps Portal
. The users that you create in
NetOps Portal
are replicated in CABI. Replicated users can access reports and dashboards without having to log in to CABI.
  • User names that contain the following special characters are not synchronized with the CABI Server:
    • , \ | ` " ' ~ ! # $ % ^ & [ ] * + = ; : ? < > } { ) ( /
    • Spaces
  • Synchronization between
    DX NetOps Performance Management
    and CABI occurs every 5 minutes. The users that you create in
    NetOps Portal
    might take up to 5 minutes to appear in CABI.
Follow these steps:
  1. On the CABI system, copy the following files that are in the
    <CA Business Intelligence>
    /apache-tomcat/webapps/jasperserver-pro/WEB-INF/config
    directory:
    • capm.properties
    • capm.jks
  2. Add the copied files in the following location on the system where
    NetOps Portal
    is installed:
    <installation_directory>
    /PC/webapps/pc/WEB-INF/CABIKeystore
Configure the CABI Authentication
Follow these steps:
  1. Open the
    <installation_directory>/IMDataAggregator
    /
    apache-karaf-*
    /etc/com.ca.im.odata.authservice.impl.AuthenticationService.cfg
    OpenAPI configuration file.
    • installation_directory
      The installation directory for the data aggregator.
      Default:
      /opt
    • apache-karaf-*
      The installation directory for Apache Karaf.
      Example:
      apache-karaf-4.2.6
  2. Customize the following parameters to match the configuration on the CABI server:
    • cookieName
      The name of the cookie containing the token. This value should match the
      openAPIcookieName
      value.
    • tokenEncryptionDecryptionKey
      The key that is used to decrypt incoming tokens. This value should match the
      encryptionKey
      value.
    • tokenTimeoutInMinutes
      The length of time, after which, the token is invalidated. This value should match the
      tokenTimeout
      value.
Verify Time Synchronization
To avoid an error when users access reports, synchronize the date and time settings in
NetOps Portal
and CABI. This error occurs when the difference in time exceeds the
Cookies Expiration Timeout
that is set in
NetOps Portal
(
Default:
20 minutes).
Next Steps