Install CA Business Intelligence Reports and Dashboards

The following procedures apply to configuring the standalone CABI integration and the Unified Dashboards and Reporting for Infrastructure Management solution. For more information, see Unified Dashboards and Reporting for Infrastructure Management.
The following procedures apply to configuring the standalone CABI integration and the Unified Dashboards and Reporting for Infrastructure Management solution. For more information, see Unified Dashboards and Reporting for Infrastructure Management.
After you install the
CA Business Intelligence
JasperReports Server, use the following procedures to set up and run
CA Business Intelligence
reports in
NetOps Portal
.
A Windows install is unsupported for
CA Business Intelligence
7.1.1.
2
Install Reports on the
CA Business Intelligence
JasperReports Server
To make
CA Business Intelligence
reports that use
DX NetOps Performance Management
data available, install them on the
CA Business Intelligence
JasperReports Server.
The capm_reports-xxxx.zip package (where "xxxx"  is the package version) is located in the
Installation_Directory/
PerformanceCenter/cabi folder after the
DX NetOps Performance Management
installation.
For
CA Business Intelligence
on Windows, before you install the reports, Powershell must be enabled.
The installation script can be used 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
User administration and authentication setting updates are excluded from the script and must be configured manually.
Follow these steps:
  1. Verify that the
    CA Business Intelligence
    JasperReports Server is available.
  2. Copy the capm_reports-xxxx.zip file to the
    CA Business Intelligence
    JasperReports Server host and unpack it into a folder for the reports.
    Ensure the report archive (capm_topn-x.x.x.zip) and the data source archive (capm_da-x.x.x.zip) are in the same folder on
    CA Business Intelligence
    JasperReports Server as the installation scripts.
  3. Run the Install.bat (Windows) or Install.sh (Unix) installation script.
    The
    DX NetOps Performance Management
    CA Business Intelligence
    content installation requires a
    CA Business Intelligence
    tomcat instance restart. The
    CA Business Intelligence
    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.
  4. Complete the following prompts:
    • Input a CA PC target host
      Specify the
      NetOps Portal
      host name. Do not specify the Data Aggregator host name.
    • Input the
      NetOps Portal
      GUID
      This prompt appears only when the installer cannot connect to the
      NetOps Portal
      server and get GUID automatically.
      The
      NetOps Portal
      GUID (unique) is used as the default password, and must be configured correctly. The GUID passes to the Data Aggregator to ensure that the request is going to the correct
      NetOps Portal
      instance.
      The following web service call on the
      NetOps Portal
      host retrieves this information:
      http://
      PC_host
      :8181/pc/center/webservice/datasources/performanceCenterGUID
      Example Response:
      <dataSourceGUID name="CA Performance Center" guid="
      66750a6b-57f6-440e-b501-d79134d9bb61
      "/>
    • Input a target CA PC port [8181]
      Specify the
      NetOps Portal
      port.
      Default:
      8181
    • Input a target schema http/https [http]
      Specify http or 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.
  5. To configure the values that are required for generating the OpenAPI token, go to the following location:
    CABIJasperReportsServer
    /WEB-INF/bundles
  6. Edit the capc_config.properties file.
    The OpenAPI token setting values must match the parameter values on the Data Aggregator for (
    cookieName
    ,
    tokenEncryptionDecryptionKey
    , and
    tokenTimeoutInMinutes
    ) in the following location:
    /opt/IMDataAggregator/apache-karaf-2.4.3/etc/com.ca.im.odata.authservice.impl.AuthenticationService.cfg
    • 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
DX NetOps Performance Management
integrates with
CA Business Intelligence
, you create and manage users in CA
NetOps Portal
. The users that you create in CA
NetOps Portal
are replicated in
CA Business Intelligence
. Replicated users can access reports and dashboards without having to log in to CABI.
Note the following:
  • User names that contain the following special characters are not synchronized with the CABI Server:
    • , \ | ` " ' ~ ! # $ % ^ & [ ] * + = ; : ? < > } { ) ( /
    • Spaces
  • Synchronization between
    DX NetOps Performance Management
    and
    CA Business Intelligence
    occurs every 5 minutes. Users that you create in CA
    NetOps Portal
    may take up to 5 minutes to appear in
    CA Business Intelligence
    .
LDAP support is planned for a future
DX NetOps Performance Management
release.
Follow these steps:
  1. On the
    CA Business Intelligence
    system, copy the following files in
    <CA Business Intelligence>
    /apache-tomcat/webapps/jasperserver-pro/WEB-INF/config
    :
    • capm.properties
    • capm.jks
  2. Add the copied files in the following location on the system where CA
    NetOps Portal
    is installed:
    <CA
    NetOps Portal
    >
    /PC/webapps/pc/WEB-INF/CABIKeystore
Add a Certificate for HTTPS-Enabled
NetOps Portal
For reporting to work in an HTTPS-Enabled
NetOps Portal
instance, you must add the appropriate certificates to the
CA Business Intelligence
trust store. The appropriate certificates are the root or intermediate certificates comprising the chain of trust for the
NetOps Portal
public certificate.
For more information, see Set Up Certificates for NetOps Portal.
Follow these steps:
  1. On the
    CA Business Intelligence
    server, enter the following URL in a browser to open CA
    NetOps Portal
    :
    https://<
    capc_hostname
    >:8182
    A warning about an un-trusted certificate appears in the browser.
    The browser prompts you to get the certificate.
  2. Save the certificate with the following name in a local folder:
    capc_cert.cer
    The certificate that you saved is the CA
    NetOps Portal
    public certificate.
    If the CA
    NetOps Portal
    public certificate is not self-signed, you must import the root and intermediate certificates used for signing the CA
    NetOps Portal
    public certificate.
    To save the certificate:
    1. Click the certificate warning button near the URL.
    2. Click Details, Copy to File.
    3. Select (DER encoded binary X.509 (.CER)).
  3. Open the command line by entering
    cmd
    .
  4. CD to the folder
    <
    CABI_INSTALL_FOLDER
    >/java/lib/security
    The folder should contain the cacerts file. The cacerts file is the
    CA Business Intelligence
    trust store file.
    If the cacerts file is not in the security folder, search for the folder under the <
    CABI_INSTALL_FOLDER
    >.
  5. Run the following command:
    <PATH_TO_JAVA
    >/bin/keytool -importcert -alias ALIAS -keystore cacerts -file <path>/capc_cert.cer
    In the -file parameter, <path> indicates the full path to the capc_cert.cer file.
  6. Enter the password for the cacerts trust store. The default password is "changeit." Then, enter Yes.
  7. CD to the folder
    <
    CABI_INSTALL_FOLDER
    >/jre/lib/security
    The folder should contain the cacerts file. The cacerts file is the
    CA Business Intelligence
    trust store file.
    If the cacerts file is not in the security folder, search for the folder under the <
    CABI_INSTALL_FOLDER
    >.
  8. Run the following command:
    <PATH_TO_JAVA
    >/bin/keytool -importcert -alias ALIAS -keystore cacerts -file <path>/capc_cert.cer
    In the -file parameter, <path> indicates the full path to the capc_cert.cer file.
  9. Enter the password for the cacerts trust store. The default password is "changeit." Then, enter Yes.
  10. Restart the
    CA Business Intelligence
    service.
Configure the CA Business Intelligence Authentication
The following OpenAPI configuration file is available on the Data Aggregator in the /opt/IMDataAggregator/apache-karaf-2.4.3/etc directory:
  • com.ca.im.odata.authservice.impl.AuthenticationService.cfg
Customize the following parameters to match the configuration on the
CA Business Intelligence
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
Date and time settings in CA
NetOps Portal
and
CA Business Intelligence
must be synchronized. If the date and time settings are not synchronized, an error can occur when users access reports. The error occurs when the difference in time exceeds the Cookies Expiration Timeout set in CA
NetOps Portal
(Default: 20 minutes).