Install and Configure CA Business Intelligence JasperReports® Server

supports CA Business Intelligence JasperReports® Server for viewing reports.
cim143
Identity Manager
supports CA Business Intelligence JasperReports® Server for viewing reports.
System Requirements for CA Business Intelligence JasperReports® Server
Use the following information to help you during the report server installation process.
Pre-Installation Checklist
Use the following checklist to ensure that you meet the minimum system and database requirements before installing the Report Server:
  • Ensure that the computer where you install CA Business Intelligence JasperReports® Server has 16 GB RAM.
  • We recommend Java version to be same on both CA Identity Manager and CA Business Intelligence JasperReports server.
  • Ensure that the system time of CA Identity Manager and JasperReports Server is same.
  • If CA Identity Manager is deployed using Virtual Appliance in demo mode, ensure that you copy the database_srv configuration from Virtual Appliance hosts (/etc) file to the JasperReports Server hosts (/etc) file. In a Windows JasperReports Server, the hosts file is located at C:\Windows\System32\drivers\etc.
  • Reports can be viewed only in Google Chrome and Mozilla Firefox.
  • Be sure that the Windows or UNIX system on which you are installing the Report Server meets the minimum system requirements.
  • If you create a database instance for the Snapshot Database, run the following scripts on the new database:
    • Microsoft SQL: C:\Program Files\CA\Identity Manager\IAM Suite\Identity\tools\imrexport\db\sqlserver\ims_mssql_report.sql
    • Oracle: C:\Program Files\CA\Identity Manager\IAM Suite\Identity\tools\imrexport\db\oracle\ims_oracle_report.sql
      To execute these scripts, the database user needs DBA, connect, and resource roles and system privileges to create tables, indexes, sessions, and views with global query rewrite permission.
  • On UNIX, set the following parameters as global in the local .profile files:
    • ORACLE_BASE: the top-level directory where Oracle is installed.
    • ORACLE_HOME: the path to the Oracle root directory under ORACLE_BASE
    • LD_LIBRARY_PATH: $ORACLE_HOME/lib32:$ORACLE_HOME/lib
      If Oracle is a 64-bit installation, use lib32. Use SQL Plus to connect to the oracle database instance to determine if it is a 64-bit installation.
    • ORACLE_SID: the SID name that is used in the tnsnames.ora file.
    • JAVA_HOME: the path to the Java root directory. Business Objects installs a JDK in the following location:
      report_server_home/jre
      Note
      : JDK 1.8 is the minimum version that is supported for reports.
    • PATH: $LD_LIBRARY_PATH:$JAVA_HOME:$JAVA_HOME/bin:$ORACLE_HOME/bin:$PATH
    • LC_ALL: en_US.UTF-8
      Note
      : Be sure that the CASHCOMP environment variable is empty.
  • On UNIX systems:
    • 3 GB of free space is required under /tmp.
    • You need access to a non-root user account to install the Report Server.
      This user should have a home directory in the local file system. For example, the following command creates a user with a local home directory:
      useradd -u 505 -g 0 -d /export/home/cabi -m cabi
      Also, add the non-root user to the install group and any group for which the root user is a member.
    • Enter the database server name in the /etc/hosts file if the database server is not on the same system as the Report Server. (If you have DNS, this step is unnecessary.)
    • If you encounter problems, inspect the SDK.log under these locations:
      /opt/CA/SharedComponents/CommonReporting4/ca-install.log
      /opt/CA/SharedComponents/CommonReporting4/CA_Business_Intelligence_InstallLog.log
Installation Information
Record the following information that you need during the Report Server installation:
  • Administrator Password
    Defines the password to log in to the Business Objects Infoview console.
  • User Name
    Identifies the username for the Report Database.
  • Password
    Identifies the administrative password credentials for the Report Database.
  • Pre-Installed Tomcat Information
    Identifies the path and port numbers for any previous installation of Tomcat. If you do not want to use a previous installation of Tomcat, Report Server installer can install Tomcat.
  • Tomcat Port Numbers
    Identifies the Tomcat connection, redirect, and shutdown ports.
Note:
If you install the Report Server on the same system as the
Identity Manager
, ensure that the Tomcat connection port does not conflict with the port number you specified for the application server URL when installing the
Identity Manager
Install CA Business Intelligence JasperReports® Server
On UNIX, ensure that the folder and sub folders containing the CA Business Intelligence JasperReports® Server installation files have executable permissions.
Example:
chmod 755 -R <CA Business Intelligence JasperReports Server Installation Root Folder>
Install CA Business Intelligence JasperReports® Server in a different computer that does not have CA Identity Manager installed. For detailed installation instructions, see the CA Business Intelligence JasperReports® Server documentation.
  • To install JasperReports Server with an external database - MSSQL, it is mandatory to use a database user with dbcreator and sysadmin roles assigned.
  • CA Business Intelligence JasperReports® Server Release 6.3 supports cluster configuration (High Availability).
Prerequisites for Using CA Business Intelligence JasperReports® Server
Perform the following steps using the CA Business Intelligence JasperReports® Server UI:
Follow these steps:
  1. Log in to the CA Business Intelligence JasperReports® Server UI as a Superuser.
  2. Create an organization with name as
    IAM
    .
    1. Navigate to Manage, Organizations.
    2. Under
      root
      organization, create an organization with name as
      IAM
  3. Create a user under the newly created organization.
    1. Navigate to Manage, Users.
    2. Select the newly created IAM organization.
    3. Click
      Add User
      .
    4. Specify the user details.
    5. Click
      Add User to IAM
      .
  4. Import the CA Identity Manager Reports zip file. The reports zip file is available in the following location, depending upon the CA Identity Manager Report database type:
    For MS-SQL, the Jasper_sql_reports.zip file is available in the following location:
    Non-vApp:
    <CA_Identity_Manager_Install_Home>\IAM Suite\Identity Manager\tools\imrexport\ReportDefinitions\IM Standard Reports\Ms-SQL_Reports
    vApp:
    \opt\CA\IdentityManager\IAM Suite\Identity Manager\tools\imrexport\ReportDefinitions\IM Standard Reports\Ms-SQL_Reports
    For Oracle, the Jasper_oracle_reports.zip file is available in the following location:
    Non-vApp:
    <CA_Identity_Manager_Install_Home>\IAM Suite\Identity Manager\tools\imrexport\ReportDefinitions\IM Standard Reports\Oracle Reports
    vApp:
    \opt\CA\IdentityManager\IAM Suite\Identity Manager\tools\imrexport\ReportDefinitions\IM Standard Reports\Oracle Reports
    1. Navigate to Manage, Server Settings.
    2. Under Settings, click
      Import
      .
    3. Click Choose File to select the appropriate zip file from your local computer.
    4. Click
      Import
      .
      You can import the reports zip file using a command-line utility also. See the following section for details.
  5. Set permissions to the newly created user .
    1. Set user permissions for the IAM organization.
      1. Navigate to
        View
        ,
        Repository
        ,
        root
        ,
        Organizations
        ,
        IAM
        .
      2. Right-click the
        IAM
        folder and click
        Permissions
        .
      3. In the
        Permissions
        dialog, click
        User
        .
      4. Select
        Read Only
        to assign a user read-only permission to the IAM organization.
      5. Click
        Apply
        .
    2. Set user permissions for the datasources folder.
      1. Navigate to
        View
        ,
        Repository
        ,
        root
        ,
        Organizations
        ,
        IAM, IM, datasources
        .
      2. Right-click the
        datasources
        folder and click
        Permissions
        .
      3. In the
        Permissions
        dialog, click
        User
        .
      4. Select
        Read + Write
        to assign a user read and write permission to the datasources folder.
      5. Click
        Apply
        .
Import the CA Identity Manager Reports File Using Command-Line Utility
Import the
Identity Manager
reports zip file using the CA Business Intelligence JasperReports® Server UI to configure the Server settings. For detailed instructions about these configurations, see CA Business Intelligence JasperReports® Server documentation.
You can import the reports zip file using a command-line utility also.
Follow these steps:
  1. In the
    Identity Manager
    computer, navigate to the following location:
    C:\Program Files\CA\Identity Manager\IAM Suite\Identity Manager\tools\imrexport\ReportDefinitions\IM Standard Reports
  2. Depending up on the object store that is used for
    Identity Manager
    , navigate to the folder MS-SQL Reports or Oracle Reports.
  3. Copy the zip file from the reports folder and place the zip file in a location of your choice in the CA Business Intelligence JasperReports® Server computer.
  4. In the CA Business Intelligence JasperReports® Server computer, navigate to the buildomatic folder. The buildomatic folder is located in the installer location.
  5. At the command prompt, run the following command:
    js-import --input-zip myExport.zip
    The reports zip file is imported.
Copy the Required Files to CA Business Intelligence JasperReports® Server
During
Identity Manager
installation, the installer creates the Jaspersoft token authentication key file (iam.jks) and the iam.properties in the following folder:
\CA\Identity Manager\IAM Suite\Identity Manager\tools\JasperKeyGen\keystore\
The installer copies these files to the following corresponding folders based on the application server type:
JBoss:
<JBOSS_HOME>/modules/com/ca/iam/cajasper/main/
WebSphere:
<WAS_HOME>/properties/
WebLogic:
<WEBLOGIC_HOME>/config/cajasper/
Follow these steps:
  1. Copy the iam.properties file and iam.jks file to the config folder under the WEB-INF folder, in the CA Business Intelligence JasperReports® Server computer.
    Example:
    <TOMCAT_HOME>\webapps\<web_application_name>\WEB-INF\config\
    <web_application_name>: Specifies the name of the web application that is mentioned in the sample-properties file while installing the JasperReports Server.
    Notes:
    • In a Virtual Appliance environment, copy
      iam.jks
      to /opt/CA/VirtualAppliance/custom/IdentityManager/keystore. You can either copy
      iam.jks
      from the JasperReports server, or create one and copy.
    • If using a cluster environment for both
      Identity Manager
      server and CA Business Intelligence JasperReports server, ensure that you maintain the same copy of iam.properties and iam.jks files in all nodes.
  2. Restart the Tomcat server in the CA Business Intelligence JasperReports® Server computer.
During upgrade or reinstallation of the
Identity Manager
Server, the iam.properties file and iam.jks file are
not
overwritten to the application server-specific folders.
You are now ready to use CA Business Intelligence JasperReports® Server for reporting.
For more information about the steps to request a report, see Reporting Using CA Business Intelligence JasperReports® Server.
Support for Multiple CA Identity Manager Environments
You can use a CA Business Intelligence JasperReports® Server for one or more
Identity Manager
environments. Specify the report server details in the Report Server Connection page in the
Identity Manager
UI.
You can use the same report server for multiple environments or can use a separate one for each environment.
Verify that the .jks files are copied to the computer that has the report server installed.
Note:
CA Business Intelligence JasperReports® Server release 6.3 supports the product that is deployed in a cluster.
Localization Support
To view the localized reports, ensure that you import the latest reports zip file available in the product installed location.
You can generate the reports using CA Business Intelligence JasperReports® Server  6.3.0 version in the following non-English languages:
  • Brazilian Portuguese
  • French
  • German
  • Italian
  • Japanese
  • Spanish
Security Recommendation
For secure access to
Identity Manager
server reports, perform the following recommended configurations:
  1. Set appropriate permissions to the JasperReport user. For permissions, see point 5 in topic, see "Prerequisites for Using CA Business Intelligence JasperReports® Server".
  2. Use secure mode of communication (HTTPS) to the JasperReport server.
  3. Enable Proxy for reporting. To enable Proxy, see section
    Configure the CA Business Intelligence JasperReports® Server Connection
    in topic How to Run a Snapshot Report - CA Business Intelligence JasperReports® Server.
Encrypt the Database Password after Installing Jaspersoft
If you are using Jaspersoft 6.3 or later, you can both change and encrypt the password after installing Jaspersoft.
Follow these steps:
  1. Stop the Tomcat Service.
  2. In the Jaspersoft Report Server installer software, navigate to the
    buildomatic\sample_conf\
    folder.
  3. Copy the 
    <
    database
    >_master.properties
    file to the
    buildomatic
    folder. The
    buildomatic
    folder is located in the installer location.
  4. Rename
    <
    database
    >_master.properties
    to
    default_master.properties
    .
  5. Open the
    default_master.properties
    file, and enter a value for
    appServerDir
    and
    dbPassword
    attributes.
  6. At the end of the file, add
    "encrypt=true",
    or uncomment the following line:
    #encrypt=true
  7. Make sure there is no
    encrypt.done=true
    parameter in the end of the file. If it’s there, remove it.
  8. Steps 8 and 9 are only for For Non-administrators:
    1. Copy the
      .jrsksp
      and
      .jrsks
      files from the user home directory. For example,
      C:\User\<LoggedIn-User>)
      to the
      <Tomcat_Home>/conf
      folder.
    2. At the Command Prompt, navigate to the
      buildomatic
      folder and run the following commands:
      For Windows:
    • set ks=<
      Tomcat_Home
      >/conf
    • set ksp=<
      Tomcat_Home
      >/conf
         For Linux:
    • export ks=<
      Tomcat_Home
      >\conf
    • export ksp=<
      Tomcat_Home
      >\conf
  9. In the Command Prompt, navigate to the
    buildomatic
    folder and run the
    js-ant
    command. This command should run and exit successfully.
    Note
    :
    Non-administrators must run the js-ant command from the same Command Prompt window that they had opened in step 8.
  10. Save and close the
    default_master.properties
    file.
  11. In the
    buildomatic
    folder, execute the following command:
    js-ant refresh-config
  12. Open the
    default_master.properties
    file again. Notice that the database password string should now appears similar to
    ENC-<
    some encrypted string
    >
    .
  13. Copy the entire database password string.
  14. Navigate to
    <Tomcat_Home>\webapps\jasperserver-pro\META-INF\
    and open
    context.xml
    . Replace the plain text password with the encrypted password.
  15. Restart the tomcat service with the following command:
    -Duser.home=<Tomcat_Home>/conf
    Note
    :
    If Tomcat is running as a Windows service, add this run-time argument to the registry. If Tomcat runs using a batch file, include this run-time argument in the batch file.