Install and Configure Advanced Reporting with Jaspersoft

Complete the following steps to set up Advanced Reporting with Jaspersoft for cappm. Configure Jaspersoft to restrict email notifications to trusted domains. Configure a dedicated JasperReports server for scheduled reports.
ccppmop153
Complete the following steps to set up Advanced Reporting with Jaspersoft for
Clarity PPM
. Configure Jaspersoft to restrict email notifications to trusted domains. Configure a dedicated JasperReports server for scheduled reports.
: For 15.5.1, 15.6, and newer releases, Jaspersoft 7.1 is required. For 15.5.0.1 and earlier releases, Jaspersoft 7.1 is recommended; however, Jaspersoft 6.4.2 is also still supported. The CA PPM documentation covers both versions.
2
Advanced Reporting Architecture and Components
To help you plan for a new installation or upgrade with Advanced Reporting, refer to the deployment architecture examples in the sizing guide for
Clarity PPM
15.x. See
Installing and Upgrading
in the English edition of the documentation. The following diagram shows a typical configuration:
This diagram shows a typical three-node Jaspersoft cluster for CA PPM
This diagram shows a typical three-node Jaspersoft cluster for CA PPM
For the best performance, we recommend the following minimum configuration:
  • 20 GB RAM for each JVM
  • 32 GB RAM for the OS
  • One (1) interactive node
  • One (1) scheduler node
For large deployments with over 1,000 simultaneous users, we recommend a three-node Jaspersoft cluster with one interactive node and two scheduler nodes. 
High-Performance Specifications
The following section lists a robust setup for Windows Server 2012 for user-acceptance testing or high-performance environments that place a premium on reporting. The CA PPM 15.x SaaS platform uses similar specifications in a three-node clustered configuration.
PPM App Server
Dual 2.4 GHz Intel Xeon
RAM
: 8 GB
PPM DB Server
MS SQL 2012
8 Core 2.4 GHz Intel Xeon
RAM
: 100 GB
DWH/Jaspersoft Reports Server
MS SQL 2012
6 Core 2.4 GHz Intel Xeon
RAM
: 14 GB
Jaspersoft Tomcat Server
Dual 2.4 GHz Intel Xeon
RAM
: 8 GB (32 GB recommended)
JVM
: 20 GB per node
New! Video: Install and Configure Jaspersoft 7.1 for CA Clarity PPM

Review the Prerequisites
  • Verify that 
    Clarity PPM
     is installed or upgraded. 
  • Download the compatible Oracle JDK and Apache Tomcat software. See the CA PPM 15.3 Release Notes
  • Set JAVA_HOME and ensure that the correct Java executables are referenced in the PATH environment variable.
    For example: (Windows)
    set PATH=%JAVA_HOME%\bin;%PATH% 
    (Linux)
    export PATH=$PATH:$JAVA_HOME/bin
  • If this is your second attempt at an installation, before starting the install process, do the following:
    • Delete the Tomcat folder, if it exists. Extract the new content from the Tomcat zip file that you downloaded from the CA Download Center.
    • Delete the JasperReports Server Database/Schema and recreate it. For more information and sample queries for supported vendors, see Create a Jaspersoft Schema and Set Permissions.
    • (Recommended) Extract the installer into a new folder.
To avoid the
file name is too long
exception, unzip the installer into the root drive (for example, C:\jaspersoft or /fs0/).
Create the JasperReports Server Schema and Set Permissions
Complete the following steps to create a database user for the JasperReports Server.
: Log in as a database user with the proper permissions; typically SYSTEM. The following steps require an Oracle database user with sufficient rights and not a root user in Linux.
Oracle
Follow these steps:
  1. Create a tablespace for the JasperReports Server.
    CREATE TABLESPACE "[JS User]_PPMJAS" DATAFILE '<ORACLE_BASE>\ORADATA\<SID>\PPM_JASPER_TS.DBF' SIZE 500M REUSE AUTOEXTEND ON NEXT 25M MAXSIZE 10G LOGGING EXTENT MANAGEMENT LOCAL SEGMENT SPACE MANAGEMENT AUTO;
  2. Create a database user and set the required permissions. 
    CREATE USER [JS User] IDENTIFIED BY [JS Password] DEFAULT TABLESPACE [JS User]_PPMJAS TEMPORARY TABLESPACE TEMP; GRANT CONNECT, RESOURCE, CREATE SESSION TO [JS User]; GRANT UNLIMITED TABLESPACE, QUERY REWRITE TO [JS User];
SQL Server
Follow these steps:
  1. Create a database (for example, PPM_JASPERSOFT).
  2. Alter database ppm_jaspersoft to set arithabort on.
  3. Alter database ppm_jaspersoft to set ansi_nulls on. 
  4. Alter database ppm_jaspersoft to set quoted_identifier on.
    IF (SELECT (CAST(LEFT(CAST(SERVERPROPERTY('ProductVersion') AS VARCHAR(20)), CHARINDEX('.', CAST(SERVERPROPERTY('ProductVersion') AS VARCHAR(20)), 1) - 1) AS INTEGER))) = 10 BEGIN exec sp_dbcmptlevel 'PPM_JASPERSOFT', @new_cmptlevel=100 END IF (SELECT (CAST(LEFT(CAST(SERVERPROPERTY('ProductVersion') AS VARCHAR(20)), CHARINDEX('.', CAST(SERVERPROPERTY('ProductVersion') AS VARCHAR(20)), 1) - 1) AS INTEGER))) = 11 BEGIN exec sp_dbcmptlevel 'PPM_JASPERSOFT', @new_cmptlevel=110 END IF NOT EXISTS (SELECT 'yes' FROM syslogins WHERE LOWER(name) = LOWER('PPM_JASPERSOFT') ) BEGIN exec sp_addlogin 'PPM_JASPERSOFT','my_password','PPM_JASPERSOFT','us_english' END
  5. Set the isolation level to read committed snapshot. 
    Make sure that the user can access the system views (such as syslockinfo, sysindexes).
    begin exec ('alter database PPM_JASPERSOFT set read_committed_snapshot on') exec ('grant VIEW SERVER STATE to PPM_JASPERSOFT') exec ('ALTER LOGIN PPM_JASPERSOFT WITH CHECK_POLICY=OFF') end USE PPM_JASPERSOFT
  6. The schema owner is referenced in the code when executing functions in SQL Server and is hard-coded to PPM_JASPERSOFT. The login name can be different.
    -- Schema owner is referenced in code when executing functions in MSSQL, -- so we intentionally hard-code it here to PPM_JASPERSOFT. Login name can differ. exec sp_grantdbaccess 'PPM_JASPERSOFT','PPM_JASPERSOFT' exec sp_defaultdb 'PPM_JASPERSOFT', 'PPM_JASPERSOFT' exec sp_addrolemember 'db_owner', 'PPM_JASPERSOFT'
Install the JasperReports Server Software
Complete the following steps to install the JasperReports software on the server.
Follow these steps:
  1. Download the Jaspersoft zip file from CA Support:
    • Search on CA PPM and locate the latest Jaspersoft download file. 
    • Jaspersoft 7.1 for CA PPM (
      ca_ppm_jaspersoft_7.1.0_w.x.y.z.zip
      ) is new as of November 2018 and strongly recommended for all releases of CA PPM; however, Jaspersoft 6.4.2 (
      ca_ppm_jaspersoft_6.4.2_5.4.2.x
      .
      zip
      ) is also supported.
    • The jaspersoft file is often included as part of an ISO image file that you can download and mount or burn to a DVD. For example:
        CA BUSINESS INTELLIGENCE JASPER REPORTS SERVER 7.1 FOR CA PPM
        CA PPM INSTALL MEDIA 15.5, DVD MASTER
        DVD01234E.iso
  2. Save the ZIP file to a local directory.
  3. Extract the contents of the file to a new folder (for example, /opt/jasperreports for LINUX or C:\Jasperreports for Windows).
    To avoid the
    file name is too long
    exception, unzip the installer into the root drive (for example, C:\jaspersoft or /fs0/).
  4. Open a command prompt and run the following command: 
    1. Linux:
      chmod u+x install.sh install.sh
      Windows:
      install.bat
  5. Select the Installation Type.
    • Fresh Installation
      This option installs the new JasperReports Server version that you downloaded in an earlier step.
  6. Enter the Apache Tomcat directory (the location where the JasperReports Server is deployed and Tomcat is installed). Install the JasperReports Server in the JasperReports Server Tomcat folder.
  7. Enter the following information:
    • Enter Jaspersoft web app name:
       Specifies the folder name where the JasperReports Server is deployed. In clustered environments, your entry should be in sync with the first instance and port number where the Jasper service needs to run. 
      For example, if reportservice is the JasperReports Server web context, the URL to access the JasperReports Server is
      http://<domain_name>:<portnumber>/reportservice
      .
    • Enter Jaspersoft web app port:
       Specifies the port where the JaspersoftReports Server runs (for example, 8080).
  8. (Optional) Enter the following information to configure the mail settings: 
    • Do you want to configure Email (y/n)?
      Press
      Y
      to configure the mail server. To skip configuration (you can set it up later) enter
      N
    • Enter Mail Server Hostname
      Specifies the hostname of the mail server (for example, mail.localhost.com).
    • Enter Mail Server Port
      Specifies the port number of the mail server (for example, 25).
    • Enter Sender Email Protocol
      Specifies the protocol that the mail server supports. The JaspersoftReports Server supports smtp and smtps (for example, exchange).
    • Enter Sender Email Username
      Specifies the user name of the mail sender (for example, test).
    • Enter Sender Email Password
      Specifies the password of the mail sender (for example, password123).
    • Enter Sender Email Address
      Specifies the mail address of the sender (for example, [email protected]). For more information, see JasperReports Server Sender Email Address.
  9. Select the Installation Mode.
    • Standalone
      (for standalone servers) or 
      Cluster
      (for clustered deployments). If you enter
      2
      for
      2) Cluster
      , at the
      Select the Cluster Node
      prompt, the following options appear:
      • 1) Primary
      • 2) Additional (Web-app Deploy Only)
        : Deploys the web app only using the primary node database schema. 
        If you are deploying an additional node, provide the database details for the primary node. For clustered environments, select
        2) Additional (Web-app Deploy Only)
        for the cluster node.
  10. The following prompt appears:
    Do you need a dedicated Jaspersoft instance as a report scheduler instance?
    If you do not want to have a separate scheduler instance, enter 
    No
    If you want a separate scheduler instance, enter 
    Yes.
    Creation of a separate scheduler node is only applicable if you are installing Jaspersoft in a cluster. You only see this option when you select
    2) Cluster
    in the previous step.
  11. The following prompt appears:
    Do you want to make the current instance as report scheduler only instance?
    To have the installer perform the necessary configuration changes and make the current instance a scheduler instance, enter
    1) Yes
    .
    For instances that are part of the load balancer, enter
    No
    . The installer performs the necessary configuration changes and makes the current instance a non-scheduler instance.
    The JasperReports Server can be deployed as a standalone application or in a cluster for high concurrency. Clustered JasperReports Server instances use thread-safe access to their private repository database. As a result, any number of JasperReports Server instances can share the same repository and present the same environment to users. When the JasperReports Server is deployed in a
    cluster
    , we advise you to dedicate one or more JasperReports Server instances in the cluster to process the execution of scheduled reports. The dedicated instances share the same repository. However, they are not part of the load balancer to serve web requests such as executing reports through the user interface or exploring data through ad hoc views. For a
    standalone
    deployment where only a single instance of the JasperReports Server is available, the instance processes report scheduling. The instance also serves normal web requests such as report execution through the user interface and exploring data through ad hoc views.
    You must select the appropriate option during the installation to have the installer make the instance either a scheduler or non-scheduler instance. You only see this option when you select
    Yes
    in the previous step. As previously noted, all of the scheduler nodes should be removed from the load balancer configuration. When you do this, the web requests are not served by scheduler nodes. The only purpose of scheduler nodes is to run scheduled reports.
  12. At the
    Select Database Type
     prompt, select
    1) Oracle
    or
    2) MSSQL
    and provide the required information in the following table. Verify the properties that you entered and wait until the installation completes.
    Database
    Prompt
    Value
    MSSQL
    SQL Server Hostname
    Enter the Hostname of the server where SQL Server is installed (for example, HOSTNAME).
    Do you want to use named instance?
    Enter
    Yes
     if you are deploying on a MS SQLSERVER Named Instance. Enter
    No
    if you are deploying on a default instance with a static port.
    -Enter MSSQL Server Instance Name
    Enter the named instance configured on MS SQLServer.
    -Jaspersoft Database Name
    Enter the JasperReports Server database name (default=PPM_JASPERSOFT).
    -Jaspersoft Database Username
    Enter the JasperReports Server user name (for example, PPM_JASPERSOFT).
    -Jaspersoft Database Password
    Enter the JasperReports Server password. Only applicable for Oracle.
    -MSSQL Server Port Number
    Enter the database port on which SQL Server runs (for example, 1433).
    -Jaspersoft Database Name
    Enter the JasperReports Server database name (default=PPM_JASPERSOFT).
    -Jaspersoft Database Username
    Enter the JasperReports Server user name (for example, PPM_JASPERSOFT).
    -Jaspersoft Database Password
    Enter the JasperReports Server password. Only applicable for Oracle.
    Oracle (Standalone)
    Oracle Database Hostname
    Hostname of the server where Oracle is installed (for example, localhost).
    Oracle Database Port Number
    Database port on which Oracle is running (for example, 1521).
    Jaspersoft Database Username
    JasperReports Server database user name (for example, PPM_JASPERSOFT).
    Jaspersoft Database Password
    JasperReports Server password.
    Oracle SID Name
    Oracle SID (for example, <ORACLESID>)
    Oracle Cluster (RAC)
    Oracle Database Hostname
    Hostname of the server where Oracle is installed (for example, localhost or an IP address).
    Oracle Database Port Number
    Database port where Oracle runs (for example, 1521).
    Jaspersoft Database Username
    JasperReports Server database user name (for example, PPM_JASPERSOFT).
    Jaspersoft Database Password
    JasperReports Server password.
    Oracle Service Name
    Oracle service name (for example, <SERVICENAME>).
Configure EHCACHE (Required for Clustered Environments Only)
JasperReports Server temporarily stores ad hoc query results for reuse. The cache is populated by the data from queries when running ad hoc views. The datasets are uniquely identified by a key for the query, the data source URI, and parameters. Caching reduces database loads and delivers frequently-used datasets to the user quickly. Caching applies when reports are created or run. JasperReports Server version 5.0 introduced a cache implementation called Ehcache that allows you to view cache entry memory size and set memory limits. You can configure the cache to optimize memory usage and response time for your usage patterns.
After installation of the secondary instance, stop both the primary and secondary instance and follow these steps to configure the local cache for the cluster.
  1. Navigate to
    D:\apache-tomcat-8.5.x\webapps\reportservice\WEB-INF
    and paste the files which are attached in this  file. The same file can be used with either Jaspersoft 6.4.2 or 7.1.
  2. Windows explorer will mention that you are trying to replace files. Proceed with the replace.
  3. When you get a multicast address from your network team open the following two files:
      D:\apache-tomcat-8.5.x\webapps\reportservice\WEB-INF\ehcache_hibernate.xml
      D:\apache-tomcat-8.5.x\webapps\reportservice\WEB-INF\classes\ehcache_hibernate.xml
  4. Edit the following tags (in red boxes) to incorporate the multicast address and port provided by the network team.
    image2018-7-19 9:54:58.png
  5. Verify that the 40011 and 40012 cache replication ports are open on the network end. You can change them to any specific ports which are deemed open by the network team. Make any changes in all members of the cluster.
  6. Primary instance has a page limit of 500 by default. To increase that to 1000, perform the following substeps:
    1. Navigate to the following directory:
      D:\apache-tomcat-8.5.x\webapps\reportservice\WEB-INF\classes\
    2. Edit the
      jasperreports.properties
      file.
    3. Search for the
      net.sf.jasperreports.governor.max.pages
      property.
    4. Change its value to
      1000
      .
  7. After completing all your configuration changes, start services on all the instances.
Known Issue with Fresh Installations of Jaspersoft 7.1
You might observe the following
Failed to execute: create index 
entry in the installation logs during a new installation of Jaspersoft 7.1.0 on Oracle 11g R2 or 12c:
[exec] [exec] init-js-db-pro:
[exec] [exec] [echo] For JDBC driver the artifactId and version properties are set:
[exec] [exec] [echo] maven.jdbc.artifactId=ojdbc8
[exec] [exec] [echo] maven.jdbc.version=12.2.0.1.0
[exec] [exec] [echo] Specified JDBC driver jar exists
[exec] [exec] [advanced-sql] Executing resource: /fs0/clarity1/install_cd/ca_ppm_jaspersoft_7.1.0/buildomatic/install_resources/sql/oracle/js-pro-create.ddl
[exec] [exec] [advanced-sql] 0 rows affected
[exec] [exec] [advanced-sql] 0 rows affected
[exec] [exec] [advanced-sql] Failed to execute: create index idx46_jiresfldr_hidden_idx on JIResourceFolder(hidden)
[exec] [exec] [advanced-sql] java.sql.SQLException: ORA-01408: such column list already indexed
[exec] [exec] [advanced-sql] 0 rows affected
[exec] [exec] [advanced-sql] 0 rows affected
[exec] [exec] [advanced-sql] Executing resource: /fs0/clarity1/install_cd/ca_ppm_jaspersoft_7.1.0/buildomatic/install_resources/sql/oracle/quartz.ddl
: You can ignore this entry. The warning appears to be alerting you about a duplicate index creation scenario; however, it is not a valid warning.
  • This warning has no impact on your installation and does not affect any Jaspersoft 7.1 functionality. 
  • CA Engineering teams confirmed that all the DDL commands are successfully executed after the reported warning.
  • The warning only appears on new Oracle installations; it does not occur with supported versions of Microsoft SQL Server 
Verify the JasperReports Server Installation
Complete the following steps to verify that the installation was successful.
Follow these steps:
  1. Start the JasperReports Server if it has not already started. 
  2. Go to the Jaspersoft Tomcat bin directory (<Jaspersoft-Tomcat-Root>/bin), and run the following command:
    Linux:
    chmod u+x ./startup.sh ./startup.sh
    Windows:
    startup.bat
  3. Open 
    http://<domain_name>:<portnumber>/<jasperwebcontext>/
    .
  4. Verify that you can open the JasperReports Server login page.
  5. Log in to the JasperReports Server using the superuser credentials.
  6. Review the install.log for any errors. 
    This file is available in the folder where you unzipped the contents of the JasperReports Server installation file.
: During the installation, the Jaspersoft license file is copied to the installation directory and appropriate user folder automatically.
JasperReports Server Post-Installation Recommendations
  • If you use Oracle, run the following query after the JasperReports Server installation to improve the overall performance of the system.
exec DBMS_STATS.GATHER_SCHEMA_STATS (ownname => USER, degree => DBMS_STATS.AUTO_DEGREE, estimate_percent => 100, cascade => true, method_opt=> 'FOR ALL COLUMNS SIZE 1');
  We recommend that you run this query frequently.
  • The Output to Host File System option saves the report output to a specified folder on the JasperReports Server host server. This option is disabled by default. For information about enabling this option, see the Jaspersoft documentation.
  • The governor limit on the JasperReports Server database connection has a timeout set to 15 minutes (900000 milliseconds). Report queries running longer than 15 minutes close and an error appears indicating the timeout. You can change the setting in the following location:
    webapps/<jasperwebcontext>/WEB-INF/classes/jasperreports.properties
    net.sf.jasperreports.governor.timeout.enabled= true
    net.sf.jasperreports.governor.timeout=900000
    : For better performance and to relieve stress on the database, do not change this setting.
  • The governor limit on the JasperReports Server pages is set to 500. This limit applies to all output formats. You can change this setting in the following location: 
    <tomcatDirectory>/webapps/<jasperwebcontext>/WEB-INF/classes/jasperreport.properties
    net.sf.jasperreports.governor.max.pages.enabled=true 
    net.sf.jasperreports.governor.max.pages=500
    Setting this limit requires a restart of the JasperReports Server.
JasperReports Server Post-Installation Configuration
After you complete and verify the JasperReports Server installation, complete the following steps to configure the JasperReports Server to work with 
Clarity PPM
. The Advanced Reporting content includes domains for use with the data warehouse. 
Configure the JasperReports Server Properties
Set the server properties for the JasperReports Server in
Clarity PPM
System Administration (CSA).
Follow these steps:
  1. Log in to CSA. The default login URL for CSA is
    http://<hostname
    >:8090/niku/app
    .
  2. Click
    Servers
    in the left navigation pane, and click the name of the local server in the list.
  3. With the
    Properties
    tab selected, click the
    Reporting
    subtab.
  4. In the 
    Report Server: Jaspersoft
     section, complete the following fields:
    • Vendor:
      Specifies the report vendor. For this section, only Jaspersoft is available.
    • Status:
      Indicates whether the JasperReports Server is available. If the server status is unavailable either because it is down, the URL is incorrect, or there is a network issue, provide a valid Web URL for the JasperReports Server.
    • Web URL:
      Specifies the web URL for the JasperReports Server (for example,
      http://<jaspersoft-hostname>:8080/<jasperwebcontext>
      ).
    • User:
      Specifies the JasperReports Server user name who performs system tasks that require administration access. The default user is ppmjasperadmin. You can change the default user name before you import Advanced Reporting content. The import creates the user.
      Do not
      change the user name after you import the Advanced Reporting content.
    • Database ID:
      Not applicable.
    • Organization Name:
      Specifies the organization name (tenant name) that is created on the JasperReports Server.
    • Organization ID:
      Specifies the organization ID (tenant ID) that is created on the JasperReports Server.
    Note:
     If the Report Server: Jaspersoft section is not available, configure the following tag in the <clarityInstallFolder>/properties.xml file:
    <reportServer id="jaspersoft" webUrl="http://<serverName>:<portnumber>/<jaspersoftwebcontext>" context="/<jaspersoftwebcontext>" home="" serviceUrl="http://<serverName>:<portnumber>" volumeName="" username="ppmJasperAdmin" vendor="jaspersoft" databaseId="Niku" jndiName="jdbc/clarity" dwJndiName="jdbc/dwh" orgName="<orgname>" orgId="<orgID>" />
  5. Click Save.
Generate the Key Store File
To authenticate 
Clarity PPM
 and the JasperReports Server, generate a trusted key store for each organization.
If you are upgrading your product release, use the following procedure to regenerate the keys and copy the key store files.
Follow these steps:
  1. Go to <clarity_home>/bin.
  2. Run the following command to generate a key store from CSA:
    admin jaspersoft keystore
     
    To specify the key and password, enter the following command: 
    admin jaspersoft keystore [-key <key> -password <password>]
    This command generates the following files in <install>/config/ and <install>/META-INF/reporting/store:
    • <orgname>.jks (key store file)
    • <orgname>.properties (information about the key)
  3. Copy these files to <Tomcat>/webapps/<jasperwebcontext>/WEB-INF/config where Jaspersoft is installed. 
    Example: <Tomcat>/webapps/reportservice/WEB-INF/config
    For clustered environments, copy these files in the same location on each of the nodes in the cluster.
  4. Start the Tomcat service where the JasperReports Server is deployed.
    The Advanced Reporting content cannot be imported without starting the reporting service.
  5. (Optional) Repeat the steps to regenerate the key or change the organization.
  6. Complete the previous steps successfully to ensure that import of the Advanced Reporting content does not fail.
Execute the Installation Commands
Before you run the installation commands, verify that you have completed the following tasks:
  • Data Warehouse status is set to Available. To confirm, refer to the Status field in the Data Warehouse section of CSA.
  • The Data Warehouse database link is created. To confirm, refer to the PPM Database Link field in the Data Warehouse section of CSA.
  • The Organization Name and Web URL are defined. To confirm, refer to the Organization Name and Web URL fields in the Reporting section of CSA.
Follow these steps:
  1. Open a command prompt and navigate to the 
    Clarity PPM
     runtime bin directory.
  2. Run the following command: 
    admin content csk
    The installation process begins and information displays on the screen. The information is captured and stored in the admin.log file that is located in the logs directory. The output files are stored in the logs/content/xog/csk directory.
  3. Run the following command using the superuser credentials to import the Advanced Reporting content: 
    admin content-jaspersoft csk -userName superuser -password <password>
  4. Review the screen output and the logs for important information after the installation completes.
Configure Users for Advanced Reporting
To set up Advanced Reporting with Jaspersoft, configure users for Advanced Reporting.
Follow these steps:
  1. Assign the the required Advanced Reporting access rights to the report users. See
    Advanced Reporting Access Rights
    .
  2. Run the Create and Update Jaspersoft Users job to synchronize the 
    Clarity PPM
     users with assigned access rights to their corresponding Jaspersoft users and roles.
The PMO Accelerator add-in includes additional roles (CSK roles) that set permissions for repository items (such as reports and domains). To configure users for CSK roles, see Advanced Reporting Roles and Permissions.
Restart the 
Clarity PPM
Services
Follow these steps:
  1. Log in to
    Clarity PPM
    System Administration.
  2. Under
    Home
    , click
    All Services
    .
  3. Select the check boxes next to the
    Clarity PPM
    Application (app) and
    Clarity PPM
    Background (bg) services.
  4. Click
    Start
    .
Run the Data Warehouse Jobs
Always run the jobs in order as listed.
Follow these steps:
  1. Run the Create and Update Jaspersoft Users job
    : This job synchronizes PPM users with assigned access rights to their corresponding Jaspersoft users and roles.
  2. Run the Time Slicing job
    : This job splits time varying data into a relational format.
  3. Run the Load Data Warehouse job
    : This ETL job extracts the data from the database, transforms the data, and loads the data into the data warehouse. This job also updates the domains.
  4. Decide which data to include
    : Open the properties for any custom object or attribute that you want to include and select the
    Include in the Data Warehouse
    option. This option must be selected for custom objects or attributes to be populated in the data warehouse. Run the Load Data Warehouse job again. Schedule this job to run in full and incremental modes with the other jobs according to a strategy that you define. See the important note below.
  5. Run the Load Data Warehouse Access Rights job:
    This job loads the access privileges for resources and investments from the database to the data warehouse. This job is initially disabled. Enable this job before you run it.
  • After installation, to populate the data warehouse, always run the Load Data Warehouse job with the
    Full Load
    option selected. The first run of this job can take a substantial amount of time.
  • The following events require you to run the Load Data Warehouse job again; however, you can run it in
    incremental
    mode:
    • Deleting an attribute or clearing the Include in the Data Warehouse option for the attribute in CA PPM Studio.
    • Changing the data type of an attribute
  • The
    following events require you to run the Load Data Warehouse job with the
    Full Load
    option selected again
    :
    • Adding a language to the data warehouse
    • Changing a timeslice date to include a larger timeframe.
When the Load Data Warehouse and Load Data Warehouse Access Rights jobs run, they write standard messages to the jobs logs and detailed messages to the data warehouse logs. The default data warehouse log files are bg-dwh.log and bg-ca.log. To review the detailed data warehouse log messages, navigate to the data warehouse logs (under the standard Jobs logs) in
Clarity PPM
System Administration. You can enable more logging by changing the Kettle Log Level. Click Servers, Logs, Edit Configuration. Use the detailed messages to monitor job progress and to analyze data warehouse load failures.
Configure Jaspersoft as a Windows Service
  1. Reference the Java executables in the 
    PATH
     environment variable. The PPM application uses Java 11 but Jaspersoft uses Java 8.
  2. Navigate to the 
    bin
     folder inside the 
    Tomcat
     folder.
  3. To create the service, enter the following command:
        service install <name_of_your_reporting_service>
    For example:
       
      service install JasperReports
  4. Enter the following command in the same directory:
      tomcat8w.exe //ES//JasperReports
    image2018-10-26_12-2-56.png
  5. In the resulting Apache Tomcat 8.5 JasperServer Properties window, click the
    Java
    tab.
  6. To edit the JVM configuration, add the following JVM parameters under the
    Java Options
    section:
     -XX:+UseConcMarkSweepGC 
     -XX:+CMSClassUnloadingEnabled
     -XX:MetaspaceSize=256m
     -Duser.home=C:\Users\Administrator
    : The first line (
    -XX:+UseConcMarkSweepGC
    ) determines the Java garbage collector method for Jaspersoft. The last line refers to the
    home
    folder of the user account for the user who installed Jaspersoft.
    image2018-10-26_12-4-44.png
  7. Specify values for
    Initial Memory Pool
    and
    Maximum Memory Pool
    . The value for 
    Thread stack size
    remains at 2048 KB.
    image2018-10-26_12-7-2.png
  8. Apply your changes.
  9. Launch the service from Windows services console.
Restart the JasperReports Server Tomcat Services
Complete the following steps to stop or start JasperReports Server.
Follow these steps:
  1. Navigate to the <tomcathome>/bin directory.
  2. To stop, run one of the following files:
    • shutdown.sh (Linux)
    • shutdown.bat (Windows)
  3. To restart, run one of the following files:
    • startup.sh (Linux)
    • startup.bat (Windows)
Uninstall JasperReports Server
Follow these steps:
  1. Stop the Tomcat service where the JasperReports Server is deployed.
  2. Rename the existing 
    <jasperwebcontext>
     folder.
  3. Back up the JasperReports Server database.
  4. Delete the JasperReports Server database from the database server.