Install CA Business Intelligence Reports and Dashboards

After you install the cabi JasperReports Server, use the following procedures to set up and run cabi reports in npc.
capm310
The following procedures apply to configuring the Unified Dashboards and Reporting for Infrastructure Management solution. 
After you install the 
CA Business Intelligence
 JasperReports Server, use the following procedures to set up and run 
CA Business Intelligence
 reports in
Performance Center
.
2
Software Requirements
The following table lists the required software.
Software
Version
Download
Notes
CA Performance Management
3.1
support.ca.com, Download Center, Download Products
A CA support login is required to download the CA PM software packages for this solution.
If you have an existing 3.1 installation, you do not need to reinstall it.
CA Business Intelligence JasperReports Server For Unified Dashboards and Reporting For Infrastructure Management
6.3
support.ca.com, Download Center, Download Products
A CA support login is required to download the CA PM software packages for this solution.
Available in the same location as the CAPM 3.1 product download.
If you installed CABI, install new one and migrate data.
Additional files for
CA Performance Management
that enable integration with Unified Dashboards and Reporting for Infrastructure Management:
  • CA_PC_3.1_LINUX_CHECKSUM FOR UNIFIED DASHBOARDS AND REPORTING
  • CA_PC_3.1_LINUX.TAR.GZ FOR UNIFIED DASHBOARDS AND REPORTING
  • CA_DA_3.1_LINUX CHECKSUM FOR UNIFIED DASHBOARDS AND REPORTING
  • CA_DA_3.1_LINUX.TAR.GZ FOR UNIFIED DASHBOARDS AND REPORTING
3.1
support.ca.com, Download Center, Download Products
A CA support login is required to download the CA PM software packages for this solution.
Install these additional files on
CA Performance Management
3.1.
Hardware Requirements
The CABI Server software is installed on a system with the following minimum resources:
  • CPU: 2.8-GHz quad-core processor
  • Disk Size: 100-G
  • Memory: 8-GB RAM - 16-GB RAM (
    Recommended
    )
Environment Requirements
This process requires the following environment:
  • A CABI Server instance. The CABI Server must have a new installation of the CA Business Intelligence JasperReports Server for Unified Dashboards and Reporting for Infrastructure Management software. For information about installation, see CA Business Intelligence JasperReports Server.
  • A
    CA Performance Management
     instance. For information about installation, see:
  • Download and install the following packages:
    • CA_PC_3.1_LINUX_CHECKSUM FOR UNIFIED DASHBOARDS AND REPORTING
    • CA_PC_3.1_LINUX.TAR.GZ FOR UNIFIED DASHBOARDS AND REPORTING
    • CA_DA_3.1_LINUX CHECKSUM FOR UNIFIED DASHBOARDS AND REPORTING
    • CA_DA_3.1_LINUX.TAR.GZ FOR UNIFIED DASHBOARDS AND REPORTING
Process Overview
The following diagram shows the sequence of tasks to complete. 
Overview of steps to configure Unified Dashboards and Reporting
Overview of steps to configure Unified Dashboards and Reporting
Configure Authentication on the 
CA Business Intelligence
 Server
To customize access to 
CA Business Intelligence
 reports that use 
CA Performance Management
 data, configure the authentication behavior on the 
CA Business Intelligence
 server. 
Follow these steps:
  1. To customize the authentication behavior, go to the following location:
    tomcat_base_directory
    /
    webapps
    /
    webappname
    /WEB-INF
  2. Edit the jasperserver-servlet.xml file and set the following value to "true":
    <property name="allowUserPasswordChange" value="true"/>
  3. Edit the applicationContext-multiTenancy-web.xml file and replace the 
    mtUserPreferencesFilter
     bean with the following XML:
    <bean id="mtUserPreferencesFilter" parent="userPreferencesFilter"
         class="com.ca.bicoe.cajasperserver.preauth.sso.filters.CAUserPreferencesFilter">
         <property name="mtUserAuthorityService" ref="${bean.internalUserAuthorityService}"/>
         <property name="profileAttributeService"><ref bean="profileAttributeServiceTarget"/></property>
         <property name="profileatrribs" value="1"/>
    </bean>
  4. Edit the applicationContext-multiTenancy.xml file and replace the 
    mtDaoAuthenticationProvider
     bean with the following XML:
    <bean id="mtDaoAuthenticationProvider" class="com.ca.bicoe.cajasperserver.preauth.sso.authentication.CADaoAuthenticationProvider">
         <!-- jdbcDaoImpl -->
         <!-- <property name="userDetailsService"><ref bean="inMemoryDaoImpl"/></property> -->
         <property name="profileAttributeService"><ref bean="profileAttributeServiceTarget"/></property>
         <property name="profileatrribs" value="1"/>
         <property name="userDetailsService"><ref bean="${bean.internalUserAuthorityService}"/></property>
         <property name="MTUserDetailsService"><ref bean="${bean.internalUserAuthorityService}"/></property>
         <property name="tenantService" ref="${bean.hibernateTenantService}"/>
         <property name="passwordEncoder"><ref bean="passwordEncoder"/></property>
    </bean>
Install Reports on the 
CA Business Intelligence
 JasperReports Server
To make 
CA Business Intelligence
 reports that use 
CA 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 
CA 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
  • Performance Center
    host name, port, and schema definition
  • TopN report files
  • Dasboard/dashlets files
  • Common folder structure to use in Shared CABI environment
User administration and authentication settings 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
    CA 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 the installation process is done during an appropriate maintenance window.
  4. Complete the following prompts:
    • Input path to CABI
      Specify a path to the installed 
      CA Business Intelligence
       JasperReports Server.
      Default:
      /opt/CA/SharedComponents/CA Business Intelligence
    If you are specifying a path with spaces in it, enclose the path in quotation marks.
     
    • Input a target host
      Specify the
      Performance Center
      host name. Do not specify the Data Aggregator host name.
    • Input the
      Performance Center
      GUID
      The
      Performance Center
      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
      Performance Center
      instance.
      The following web service call on the
      Performance Center
      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 port [8181]
      Specify the 
      Performance Center
      port.
      Default:
       8181
    • Input a target schema HTTP/HTTPS [HTTP]
      Specify HTTP or HTTPS.
      Default:
       HTTP
    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.
Manage Users
A set of default users is created on the 
CA Business Intelligence
 JasperReports server. The 
jasperadmin
 user gets the administrator and user roles. The 
joeuser
 user gets only the user role. Add users and user roles as necessary.
Follow these steps:
  1. Open the 
    CA Business Intelligence
     JasperReports Server login page in a browser and log in with the 
    CA Business Intelligence
     superuser account.
  2. Go to 
    Manage
    Users
    .
  3. Select the required organization in the Organizations panel.
  4. Add/delete users if necessary. Select a user to manage user roles.
    Ensure the username and password for each
    CA Business Intelligence
    user matches the username and password for each corresponding
    Performance Center
    user. LDAP support is planned for a future
    CA Performance Management
    release.
Add a Certificate for SSL-Enabled
Performance Center
For reporting to work in an SSL-Enabled
Performance Center
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
Performance Center
public certificate. For more information, see Set Up SSL Certificates.
Follow these steps:
  1. Launch a report from 
    CA Business Intelligence
    .
    If the appropriate certificates are missing from the trust store, an untrusted certificate error appears in the browser.
  2. Save the certificates that were used to sign the
    Performance Center
    public certificate as CER files in a local folder.
  3. Add the certificates to the 
    CA Business Intelligence
     trust store.
  4. Restart the 
    CA Business Intelligence
     Tomcat 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.