Upgrade Jaspersoft and Migrate Advanced Reporting Content

CA PPM SaaS customers enjoy an automatic upgrade to the latest release of JasperReports (7.1 is now available to replace 6.4.2).
ccppmop153
CA PPM SaaS customers enjoy an automatic upgrade to the latest release of JasperReports (7.1 is now available to replace 6.4.2).
CA PPM on-premise customers can decide to upgrade now or defer until a future CA PPM upgrade. For example, you are on 15.2 with JasperReports 6.4.2. You will upgrade to CA PPM 15.6 in 2019. At that time, your reporting solution will also be upgraded to JasperReports 7.1. As an on-premise customer, if you decide to upgrade, you must use the CA PPM Jaspersoft installer, a customized wrapper written on top of the original third-party installer. Only the CA installer (a ZIP archive you can download) can be used to install Jaspersoft and integrate it with CA PPM for reporting.
JasperReports Server 6.4.2 is a maintenance release and 7.1 is a new release. Both include improvements requested by customers. For security and new features, we strongly recommend upgrading to 7.1. For a summary of the changes, see CA PPM 15.3.0.5 and Jaspersoft Cumulative Patch README Files. For information about the status of specific cases, visit TIBCO Jaspersoft Technical Support (http://support.tibco.com). 
Upgrade the JasperReports Server version and update the Advanced Reporting content for the current release. You can also migrate (export and then import) your Advanced Reporting content. See Export, Import, or Migrate Advanced Reporting Content.
Jaspersoft 7.1 Advanced Reporting and Analytics
All supported releases of CA PPM now include support for the performance and security updates in Jaspersoft 7.1 (strongly recommended), with 6.4.2 also available. CA PPM 15.5.1 on-premise and all SaaS environments include Jaspersoft 7.1.
For on-premise customers, the Jaspersoft installer for both versions is similar and prompts you for an installation type: 
fresh installation
 or 
upgrade
. You can install a new report server database or perform an in-place upgrade of your existing report server database. 
Although Jaspersoft 6.4.2 is a maintenance update and 7.1 represents a new release, and neither are labeled
patches
, their upgrade steps are relatively easy, similar to a patch. You can download 7.1 and install or upgrade much like a patch.
If you choose 
upgrade
, the following choices appear in the installer command lines:
Select Installation Type: 1) Fresh Installation 2) Upgrade Installation Type selected: upgrade
Select Upgrade Method:
1) New DB Upgrade - New Jaspersoft Report Server database will be used for upgrading to 6.4.2 or 7.1 2) Same DB (in-place) Upgrade - Existing Jaspersoft Report Server database will be upgraded to 6.4.2 or 7.1
: A
Same DB
upgrade can fail for one or more of the following reasons:
  • Your are running an unsupported release of Jaspersoft. The minimum Jaspersoft version supported for a
    Same DB
    upgrade is 6.2.1.
  • You are running an unsupported release of Tomcat. The minimum version supported is 7.0.x, and 8.5.x is recommended. Jaspersoft 6.4.2 requires Tomcat 8.5.13 or higher. For Jaspersoft 7.1, we recommend Tomcat 8.5.30.
  • You are attempting to upgrade Jaspersoft on a server with an unsupported release of Oracle or MS-SQL. The minimums for CA PPM 15.4 are MS-SQL Server 2014 or Oracle 12cR2.
: If you are upgrading from an older release and older database, you might also need to upgrade to a temporary intermediate release
before
you can upgrade your database. See the upgrade scenarios under
Upgrade Enhancements
later on this page for guidance. Same DB upgrades require that you already have Oracle 11g R2, Oracle 12c R2, or Microsoft SQL Server 2014.
Jaspersoft and CA PPM UI Themes 
To support a consistent viewing experience, Jaspersoft theme cascading style sheets (CSS) updates are included in the CA PPM Studio user interface themes. Application and reporting themes are generally consistent.
Upgrade Action
: No action is required unless you applied customizations. New releases of CA PPM attempt to provide backward compatibility; however, any customizations from a previous release may no longer be supported. Review any modified or custom themes after every major release. Update any required images, colors, font sizes, spacing parameters, or other details.
The following points summarize the behavior of UI themes when navigating between Classic CA PPM pages and Jaspersoft Advanced Reporting pages embedded in CA PPM:
  • You select one of the available default CA PPM Studio UI themes. The Advanced Reporting user interface also appears in the same theme.
  • You edit one of the default UI themes. Your changes are not visible in Advanced Reporting until you log out and log back in again.
  • You configure a new custom UI theme in CA PPM Studio. The theme does not exist in the admin repository in Jaspersoft. The Advanced Reporting pages continues to appear in the default UI theme. 
JRE_HOME No Longer Required
Before Jaspersoft 6.4.2, our Jaspersoft 6.2, 6.1, and 5.6 installers required both JAVA_HOME and JRE_HOME. Because JRE_HOME is not required, that parameter no longer appears as a required entry for the new Jaspersoft 6.4.2 or 7.1 installers for CA PPM.
Upgrade the Jaspersoft Server: New Database Option
Upgrade your Jaspersoft server to enable Jaspersoft improvements and Advanced Reporting content enhancements. This upgrade process requires that you first export the server-level content from the previous 
Clarity PPM
 release. You then provide this content zip when prompted during the Jaspersoft upgrade process.
 
Follow these steps:
  1. Verify that the JasperReports Server 6.1.0 or 6.2.1 is configured before you attempt to upgrade to 6.4.2. Verify you have 6.4.2 before you attempt to upgrade to 7.1.
  2. Verify that 
    Clarity PPM
     Release 14.3 or higher is installed and the JasperReports Server is associated with it. If you are on 14.2 with JasperReports Server 5.6.1, it is mandatory to upgrade to
    Clarity PPM
    15.1 or higher before upgrading to Jaspersoft 6.4.2.
  3. Verify that the csk content was imported onto the server that you want to export.
  4. Export the server-level data from the JasperReports Server still on the previous release (6.1.0, 6.2.1, or 6.4.2). Click Manage, Server Settings, Export.
    A new <content>.zip file appears in the specified folder.
  5. Download the latest JDK 8 and Tomcat 8.5.23 or higher software from the vendors. For Jaspersoft 7.1, we recommend Tomcat 8.5.30. Set JAVA_HOME and reference the correct java8 executables in the PATH environment variable.
    Examples:
    (Windows) 
    set PATH=%JAVA_HOME%\bin;%PATH%
    (Linux) 
    export PATH=$PATH:$JAVA_HOME/bin
  6. Back up the existing JasperReports Server instance (WebApp) and database (database/schema).
  7. Shut down the existing Tomcat 7 services in the system.
  8. Create a JasperReports Server database schema with a new name before starting the upgrade.
  9. If this is the second attempt at an upgrade, perform the following actions before starting the upgrade process again:
    1. Delete the <Tomcat8.5.30>\<WebApp> folder, if it was created.
      Examples:
      (Windows) rmdir <Tomcat8.5.30>\webapps\<reportservice>
      (Linux) rm -rf <Tomcat8.5.30>/webapps/<reportservice>
    2. Delete the JasperReports Server schema/database and recreate it. Sample queries for supported vendors are provided in Install and Configure Advanced Reporting with Jaspersoft.
      Delete Oracle Schema/Database:
      DROP USER [JS User] CASCADE;
      Delete SQL Server Schema/Database:
      DROP DATABASE [PPM_JASPERSOFT];
      DROP LOGIN [PPM_JASPERSOFT];
      Note:
       We recommend that you extract the installer into a new folder.
  10. When performing upgrades in cluster mode, complete the following steps:
    1. For the primary node, select the
      Upgrade
      option and point to the content zip file that was exported from the previous JasperReports Server instance.
    2. For the secondary node, complete the following steps:
      • Select
        New
        when prompted for the installation type.
      • Installation mode:
        Cluster
      • Cluster Node: Additional (Web-app deploy Only)
      • Complete the Installation. Verify your data and all the cluster nodes are behaving as expected.
      Provide the Primary node database details when prompted.
  11. Use a new and clean Tomcat 8.5.x for upgrade. Avoid using the previously existing Tomcat server.
  12. Log in to CA Support Online and navigate to the 
    Clarity PPM
     Product Support download page.
  13. Search and locate the 
    ca_ppm_jaspersoft_6.4.2_.zip
    or
    ca_ppm_jaspersoft_7.1_.zip
    file. Save the zip file to a local directory.
  14. Unzip the contents of the file to a new folder (for example, /opt/jasperreports (UNIX) or C:\Jasperreports (Windows).
    It is recommended to unzip the installer into the root drive to avoid the
    file name is too long
    exception (for example, C:\jaspersoft or /fs0/).
  15. Open a command prompt and run the following commands:
    • Linux:
      chmod u+x install.sh
      install.sh
    • Windows
      :
      install.bat
  16. For
    Installation Type
    , select
    Upgrade
    .
  17. For
    Select Upgrade Method,
    select
    New DB Upgrade
    .
  18. Enter the Apache Tomcat 8.5.x directory where the JasperReports Server is deployed and Tomcat is installed.
  19. Enter the following information:
    1. Enter Jaspersoft web app name
      . Specifies the folder name where the JasperReports Server is deployed. For example, if reportservice is the JasperReports Server web context, the URL to access the JasperReports Server is http://<domain_name>:<portnumber>/reportservice.
    2. Enter Jaspersoft web app port
      . Specifies the port on which the JasperReports Server runs (for example, 8080). (Optional) Enter the following information to configure the mail settings:
      • Do you want to configure Email (y/n)?
        Select Y to configure the mail server.
      • 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.
  20. Select the Installation Mode:
    1. Standalone (for standalone servers)
    2. Cluster (for Cluster-based deployments)
      • Primary Node
      • Additional Node (Web-app deployment 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.
  21. Do you need a dedicated Jaspersoft instance as a report scheduler instance?
    Yes
    . Choose this option if you do not want to have a separate scheduler instance.
    No
    . Choose this option if you want a separate scheduler instance.
    Creation of a separate scheduler node is only applicable if you are installing Jaspersoft in the Cluster installation mode. You only see this option when you select Cluster in the previous step.
  22. Do you want to make the current instance as report scheduler only instance?
    Yes
    . Choose this option to have the installer perform the necessary configuration changes and make the current instance a scheduler instance.
    No
    . Choose this option for instances that are part of the Load Balancer. The installer performs the necessary configuration changes and makes the current instance a non-scheduler instance.
    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.
  23. Select the Database Server Type and provide the required information as specified in the following table:
    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?
    Choose 
    Yes
     if you are deploying on a MS SQLSERVER Named Instance. Choose
    No
    if you are deploying on a default port instance.
    Choose
    Yes
    to install on a MS SQLSERVER Named Instance.
    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.
    Choose 
    No
     to install on a MS SQLSERVER default instance with a static port.
    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).
    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 Service Name
    Oracle service name (for example, <SERVICENAME>).
  24. To continue with the upgrade, select
    Yes
    .
  25. Provide the Absolute Path of the Jaspersoft content zip file. This is the absolute path to the exported content zip from the previous Jaspersoft.
  26. Verify the properties that you entered and wait until the installation completes.
  27. After installation, copy the tenant-level keystores from the older tomcat7 service (<old-tomcat>/webapps/reportservice/WEB-INF/config/*) to newer tomcat 8.5.x (<new-tomcat>/webapps/reportservice/WEB-INF/config/).
Upgrade the Jaspersoft Server: Same Database Option
Upgrade your Jaspersoft server to enable Jaspersoft improvements and Advanced Reporting content enhancements. This upgrade process requires that you first export the server-level content from the previous 
Clarity PPM
 release. You then provide this content zip when prompted during the Jaspersoft upgrade process.
 
 Same (in-place) DB is only supported from Jaspersoft 6.2.1 to 6.4.2, or from 6.4.2 to 7.1. Older versions of Jaspersoft (5.6.1 and 6.1.0) will not support same db upgrades. You have to either do a new db installation or do a fresh installation followed by PPM admin migrate command.
 For same (in-place) db upgrades, use a fresh and clean Apache Tomcat 8.5.x server. For same db upgrades, there is no need to create schema again. Existing Jaspersoft 6.2.1 schema will be upgraded.
 Same (in-place) db upgrade happens to all the tenants/organization in the Jaspersoft setup. The installer will impact the entire reporting system. This is never for a single tenant/organization. If the installation is on the same instance, make sure you shutdown the older tomcat services.
 Make a backup of the tenant-level keystores from the older tomcat7 service (<old-tomcat>/webapps/reportservice/WEB-INF/config/*).
: Use the existing machine/box/node/instance or a new machine/box/node/instance to deploy Jaspersoft 6.4.2 or 7.1 with Tomcat 8.5.x, as along as you point to the previous existing 6.2.1 or 6.4.2 db schema.
 The CA JaaS installer does not make any backup of the tomcat reportservice WAR file or db schema. Make sure you make all the backups before triggering the upgrade.
 Same db upgrade is certified for Oracle 11gR2 (11.2.0.4), Oracle 12cR2 (12.2.0.1), and Microsoft SQLServer 2014.
 
Follow these steps:
  1. Verify that the JasperReports Server 6.2.1 or 6.4.2 is configured.
  2. Verify that CA PPM Release 14.4 or higher is installed and the JasperReports Server is associated with it. 
  3. Verify that the csk content was imported into the server that you want to export.
  4. Export the server-level data from the old JasperReports Server 6.2.1 using the UI (Manage, Server Settings, Export). The <content>.zip file is created in the specified folder.
  5. Download the latest JDK and Tomcat 8.5.x software from the vendors. Set JAVA_HOME for executables referenced in the PATH environment variable. 
    Examples:
    (Windows) 
    set PATH=%JAVA_HOME%\bin;%PATH%
    (Linux) 
    export PATH=$PATH:$JAVA_HOME/bin
  6. Back up the existing JasperReports Server instance (WebApp) and database (database/schema).
  7. shut down the tom cat services in the system.
  8. If this is the second attempt at an upgrade, perform the following actions before starting the upgrade process again:
    1. Delete the previous <Tomcat 8.5.x>\<WebApp> folder, if it was created.
      Examples:
      (Windows) rmdir <Tomcat 8.5.23>\webapps\<reportservice>
      (Linux) rm -rf <Tomcat7>/webapps/<reportservice>
  9. When performing Upgrades in Cluster mode, complete the following steps:
    1. For the primary node, select the Upgrade option and proceed with the upgrade by pointing to the content zip file that was exported from the previous JasperReports Server instance.
    2. For the secondary node, complete the following steps:
      • Select New when prompted for the Installation type.
      • Installation mode: Cluster
      • Cluster Node: Additional (Web-app deploy Only)
      • Complete the Installation. Verify your data and all the cluster nodes are behaving as expected.
       
      Important!
       Provide the Primary node database details when prompted.
  10. Use a new and clean Tomcat for upgrade. Avoid using the previously existing Tomcat server.
  11. Log in to CA Support Online and navigate to the CA PPM Product Support page.
  12. Under Quick Access, click Download center. Search and locate the 
    ca_ppm_jaspersoft_6.4.2.zip
    or
    ca_ppm_jaspersoft_7.1.zip
    file. Save the zip file to a local directory.
  13. Unzip the contents of the file to a new folder (for example, /opt/jasperreports (UNIX) or C:\Jasperreports (Windows).
    It is recommended to unzip the installer into the root drive (for example, C:\jaspersoft or /fs0/) to avoid the file name is too long exception.
  14. Open a command prompt and run the following commands:
    • Linux:
      chmod u+x install.sh 
      install.sh
    • Windows
      :
      install.bat
  15. Select the Installation Type.
    Upgrade
    . This option upgrades to the ca_ppm_jaspersoft_x.zip JasperReports Server version. Select the upgrade method as:
    • Same DB (In-Place) Upgrade:
      Existing Jaspersoft report server database is upgraded to Jaspersoft 6.4.2 or 7.1 version.
       
  16. Enter the Apache Tomcat directory. This is the location where the JasperReports Server is deployed and Tomcat is installed.
  17. Enter the following information:
    1. Enter Jaspersoft web app name
      . Specifies the folder name where the JasperReports Server is deployed. For example, if reportservice is the JasperReports Server web context, the URL to access the JasperReports Server is http://<domain_name>:<portnumber>/reportservice.
    2. Enter Jaspersoft web app port
      . Specifies the port on which the JasperReports Server runs (for example, 8080). (Optional) Enter the following information to configure the mail settings:
    1. Do you want to configure Email (y/n)?
      Select Y to configure the mail server.
    2. Enter Mail Server Hostname
      Specifies the hostname of the mail server (for example, mail.localhost.com).
    3. Enter Mail Server Port
      Specifies the port number of the mail server (for example, 25).
    4. Enter Sender Email Protocol
      Specifies the protocol that the mail server supports. The JaspersoftReports Server supports smtp and smtps (for example, exchange).
    5. Enter Sender Email Username
      Specifies the user name of the mail sender (for example, test).
    6. Enter Sender Email Password
      Specifies the password of the mail sender (for example, password123).
    7. Enter Sender Email Address
      Specifies the mail address of the sender (for example, [email protected]). For more information, see JasperReports Server Sender Email Address.
  18. Select the Installation Mode.
    1. Standalone (for standalone servers)
    2. Cluster (for Cluster-based deployments)
      • Primary Node
      • Additional Node (Web-app deployment only): Deploys the web app only using the Primary Node Database/Schema. 
         
        Important!
         If you are deploying an additional node, provide the database details for the Primary Node.
  19. Do you need a dedicated Jaspersoft instance as a report scheduler instance?
    Yes
    . Choose this option if you do not want to have a separate scheduler instance.
    No
    . Choose this option if you want a separate scheduler instance.
     
    Important!
     Creation of a separate scheduler node is only applicable if you are installing Jaspersoft in the Cluster installation mode. You only see this option when you select Cluster in the previous step.
  20. Do you want to make the current instance as report scheduler only instance?
    Yes
    . Choose this option to have the installer perform the necessary configuration changes and make the current instance a scheduler instance.
    No
    . Choose this option for instances that are part of the Load Balancer. The installer performs the necessary configuration changes and makes the current instance a non-scheduler instance.
     
    Important!
     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.
  21. Select the Database Server Type and provide the required information as specified in the following table.
    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?
    Choose 
    Yes
     if you are deploying on a MS SQLSERVER Named Instance. Choose 
    No
     if you are deploying on a default port instance.
    Choose 
    Yes
     to install on a MS SQLSERVER Named Instance.
    Enter MSSQL Server Instance Name
    Enter the named instance configured on MS SQLServer.
    Jaspersoft Database Name
    Enter the existing (6.2.1) JasperReports Server database name (default=PPM_JASPERSOFT).
    Jaspersoft Database Username
    Enter the existing (6.2.1) JasperReports Server user name (for example, PPM_JASPERSOFT).
    Jaspersoft Database Password
    Enter the existing (6.2.1) JasperReports Server password. Only applicable for Oracle.
    Choose 
    No
     to install on a MS SQLSERVER default instance with a static port.
    MSSQL Server Port Number
    Enter the database port on which SQL Server runs (for example, 1433).
    Jaspersoft Database Name
    Enter the existing (6.2.1) JasperReports Server database name (default=PPM_JASPERSOFT).
    Jaspersoft Database Username
    Enter the existing (6.2.1) JasperReports Server user name (for example, PPM_JASPERSOFT).
    Jaspersoft Database Password
    Enter the existing (6.2.1) 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
    existing (6.2.1) JasperReports Server database user name (for example, PPM_JASPERSOFT).
    Jaspersoft Database Password
    existing (6.2.1) 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).
    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 Service Name
    Oracle service name (for example, <SERVICENAME>).
  22. Continue with yes, to proceed with the upgrade.
  23. Verify the properties that you entered and wait until the installation completes.
  24. After installation of 6.4.2 or 7.1, copy the tenant-level keystores from the older tomcat7 service (<old-tomcat>/webapps/reportservice/WEB-INF/config/*) to newer tomcat 8.5.30 (<new-tomcat>/webapps/reportservice/WEB-INF/config/) service.
: Read the entry for the
Create and Update Jaspersoft Users
job on the CA PPM Jobs Reference page.
Verify the JasperReports Server Installation
 Complete the following steps to verify that the JasperReports Server installation was successful.
  1. Start the JasperReports Server if it has not already started.
  2. Open 
    http://<domain_name>:<portnumber>/<jasperwebcontext>/
    .
  3. Verify that you can open the JasperReports Server login page.
  4. Log in to the JasperReports Server using the superuser credentials.
  5. 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.
Jaspersoft Upgrade Tips
:
  • The Create and Update Jaspersoft Users job Full Sync option deletes all user folders with no content.
  • Create a small amount of custom Jaspersoft folders for each team. For example, only for PPM admins, project managers, and a few business analysts.
  • If this is not convenient, create users in PPM and place a small file inside each folder to avoid it from being deleted.
  • For better performance, do not create more than 500 user folders.
Post Installation Configuration
Perform the following steps to upgrade the CSK content after the installation completes:
  1. Open a command prompt and navigate to the 
    Clarity PPM
     runtime bin directory.
  2. Run the following command to verify that you have latest csk changes:
    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. Navigate to the 
    Clarity PPM
     runtime bin directory.
  4. Run the following command to import the Jaspersoft Advanced Reporting content:
    admin content-jaspersoft csk -userName superuser -password <password> upgrade
    If you have a specific file to import, add the -filename parameter.
  5. Review the screen output and the logs for important information after the installation completes.
Generate the Key Store File
Note
: Skip this step if you already copied the tenant-level keystores from the older tomcat7 service (<old-tomcat>/webapps/reportservice/WEB-INF/config/*) to newer tomcat 8.5.30 (<new-tomcat>/webapps/reportservice/WEB-INF/config/) service.To authenticate 
Clarity PPM
 and JasperReports Server, generate a trusted key store for each organization.
Note:
 If you are upgrading your product release, use the following procedure to regenerate the keys and copy the key store files. We recommend that you use a new Tomcat folder during an upgrade. The key store files are not copied to the new JasperReports Server context. Perform the following steps to complete the setup.
  1. Navigate to <clarity_home>/bin.
  2. Run the following command to generate a key store from the CSA:
    admin jaspersoft keystore
    To specify a key and password, enter the following command:
    admin jaspersoft generate [-key <key> -password <password>]
    These commands generate the following files in <install>/config/ and <install>/META-INF/reporting/store.
    • <orgname>.jks (key store file)
    • <orgname>.properties (information about the key)
      The available file is used depending on the J2EE server or Tomcat.
  3. Copy these files to <Tomcat>/webapps/<jasperwebcontext>/WEB-INF/config (where JasperReports Server is installed).
    Example:
     <Tomcat>/webapps/reportservice/WEB-INF/config
    Note:
     For clustered environments, copy these files to the same location on each of the nodes in the cluster.
  4. Start the Tomcat service where the JasperReports Server is deployed.
    Note:
     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.
Update Profile Attributes
After you complete the JasperReports Server version upgrade and regenerate the key store file, update the profile attributes. Open a command prompt in the 
install directory
/bin and execute the following command:
admin update jasperParameters
This command updates the profile attributes so that the attributes can be re-encrypted.
Memory Leak Errors May Appear in Tomcat Logs after Stopping or Starting the Server
Occasionally, you may see the following error messages in Tomcat, especially when you are restarting the JasperReports Server after maintenance. These errors have been reported on the Linux platform, although they may also be seen in Windows. Related to these errors, you may notice that the Tomcat process does not exit gracefully, or that Advanced Reporting is not accessible even when the port is available.
org.apache.catalina.loader.WebappClassLoader checkThreadLocalMapForLeaks
SEVERE: The web application [/reportservice] created a ThreadLocal with key of type [org.apache.log4j.helpers.ThreadLocalMap] (value [[email protected]]) and a value of type [java.util.Hashtable] (value [{SESSION_ID=5C55FD9CCE7272C7FF20B2E6D122F97D, USER_ID=admin|abc123}]) but failed to remove it when the web application was stopped. Threads are going to be renewed over time to try and avoid a probable memory leak.
org.apache.catalina.loader.WebappClassLoader checkThreadLocalMapForLeaks
SEVERE: The web application [/reportservice] created a ThreadLocal with key of type [net.sf.jasperreports.engine.fonts.FontUtil$1] (value [net.sf.[email protected]]) and a value of type [java.util.HashSet] (value [[Arial]] ) but failed to remove it when the web application was stopped. Threads are going to be renewed over time to try and avoid a probable memory leak.
SEVERE: The web application [/reportservice] created a ThreadLocal with key of type [java.lang.InheritableThreadLocal] (value [[email protected]]) and a value of type [org.springframework.security.authentication.UsernamePasswordAuthenticationToken] (value [org.springframew[email protected]cd0a3791: Principal: MetadataUserDetails: admin; Credentials: [PROTECTED]; Authenticated: true; Details: null; Granted Authorities:
Resolution:
Verify that the JasperReports Server Tomcat process is not present after performing a shutdown (for example, 
"ps -ef | grep tomcat"
).If the process is present, kill the process gracefully (for example, 
kill -9 <ProcessID>
).Start up the Tomcat process again.
Upgrade Advanced Reporting Content
Note:
 You must generate the key store file before you upgrade the Advanced Reporting content.If you installed Advanced Reporting content previously, upgrade the content for the current release.Open a command prompt in the 
install directory
/bin and execute the following command:
admin content-jaspersoft <contentPackId> upgrade [-userName <user name>] [-password <password>] [-force]
  • ContentPackId
    : Provide the add-in ID to associate with the Advanced Reporting content installation.
  • userName
    : Enter the super user Jaspersoft user name.
  • password
    : Enter the password for the Jaspersoft super user.
  • force
    : (Optional) Use this option to re-import the upgrade content only. You can decide to use this option after you performed a previous upgrade and you noticed a data inconsistency with the content.
Note:
 The force option is only applicable with the upgrade option.
Restore Domains after Upgrading Advanced Reporting Content
The domains that you import during the Jaspersoft Advanced Reporting content upgrade can become corrupt. This can occur while adding or removing customizations during the Load Data Warehouse job. The domains and reports in the application exhibit the following signs of data corruption:
  • Incorrect data.
  • Existing data that does not appear.
  • Reports that do not run correctly.
You can restore out of the box domains using the Restore Domain Job or by using the Command Line.
Restore Domains Job
As the 
Clarity PPM
 System administrator, run the Restore Domains job to restore the out-of-the-box domains to their original state and dynamically update these domains with the appropriate custom objects and attributes.By default, the Restore Domains job is in an Active state. If you disable the job and if you upgrade your Jaspersoft version, the Restore Domains job remains disabled.
CA PPM customers on versions 14.4 and 15.1 must apply either 14.4.0.6 patch or 15.1.0.4 patch, respectively, or a newer patch or release, to use the Restore Domains Job. Additionally, customers must apply the Jaspersoft Server Cumulative Patch 6.2.1_5.2.1.2.6 or higher. The Restore Domains Job does not complete if you do not have the right Jaspersoft Server configured.
Restore Domains Using the Command Line
Use a command option to import the domains and run a dynamic domain update.Open a command prompt in the 
install directory/bin
 and execute the following command:
admin content-jaspersoft <contentPackId> restoreDomains [-userName <userName>] [-password <password>]
  • ContentPackId
    .
     
    Provide the add-in ID to associate with the Advanced Reporting content installation.
  • userName
    .
     
    Enter the super user JasperReports Server user name.
  • password
    .
     
    Enter the password for the JasperReports Server super user.
Apply the JasperReports Server Cumulative Patch
Apply the JasperReports Server cumulative patch after you have completed a successful JasperReports Server installation. This patch and the CA JDBC Adapter allow you to access Jaspersoft Studio without using a virtual private network (VPN).You can then build reports with Jaspersoft Studio without the need for VPN access to the database servers. This patch also corrects a number of issues that previously occurred with the JasperReports Server.For more information about the corrected issues, see the README.txt file that accompanies the patch.
Cumulative Patch Pre-Installation
Follow these steps:
  1. Shut down the Tomcat service (where JasperReports Server is deployed).
  2. Back up the JasperReports Server database schema.
  3. Zip the JasperReports Server webapp folder in the Tomcat webapp folder. When you zip the folder, provide a meaningful name for the zip file, identifying the purpose of the backup. Move the zip file to a different location in the file system (for example, 
    /fs0/reportservice-backups
     for UNIX or 
    C:\Jasperreports\reportservice-backups
     for Windows).
Update Profile Attributes
After you complete the JasperReports Server version upgrade and regenerate the key store file, update the profile attributes.
  1. Open a command prompt in
    install directory
    /bin.
  2. Execute the following command:
admin update jasperParameters
This command updates the profile attributes so that the attributes can be re-encrypted.
Upgrade Advanced Reporting Content
If you installed Advanced Reporting content previously, upgrade the content for the current release.
  1. Open a command prompt in 
    install directory
    /bin.
  2. Execute the following command:
admin content-jaspersoft <contentPackId> upgrade [-userName <user name>] [-password <password>] [-force]
  • ContentPackId: 
    Provide the add-in ID to associate with the Advanced Reporting content installation.
  • userName: 
    Enter the super user Jaspersoft user name.
  • password: 
    Enter the password for the Jaspersoft super user.
  • force: 
    (Optional) Use this option to re-import the upgrade content only. You can decide to use this option after you performed a previous upgrade and you noticed a data inconsistency with the content. The force option is only applicable with the upgrade option.
Restore Domains after Upgrading Advanced Reporting Content
The domains that you import during the Jaspersoft Advanced Reporting content upgrade can become corrupt. Domain corruption can occur while adding or removing customizations during the Load Data Warehouse job. The domains and reports in the application exhibit the following signs of data corruption:
  • Incorrect data
  • Existing data that does not appear
  • Reports that do not run correctly.
You can restore the domains. Use a command option to import the domains and run a dynamic domain update.
  1. Open a command prompt in 
    install directory/bin
  2. Execute the following command:
    admin content-jaspersoft <contentPackId> restoreDomains [-userName <userName>] [-password <password>]
  • ContentPackId: 
    Provide the add-in ID to associate with the Advanced Reporting content installation.
  • userName: 
    Enter the super user Jaspersoft user name.
  • password: 
    Enter the password for the Jaspersoft super user.
UI Customizations During Upgrade
The JasperReports Server UI is customizable using Cascading Style Sheets (CSS). The themes mechanism exposes the CSS of the UI through the repository. This makes it easy for administrators to change the appearance of the UI. Changes include images, colors, font size, spacing, and even the general layout. New releases of CA PPM attempt to provide backward compatibility. However, to improve the UI and to provide new features, CA PPM cannot ensure that all your customizations from a previous release still apply.
We recommend that you review your customized theme after every major release. If necessary modify and update your customized theme.
Post-Upgrade Folder Level and User Level Security
After the upgrade, the folder-level or user-level security can get reset by the installer.
  1. To check if a user has the required rights, log in to CA PPM Advance Reporting with an account that does not have administrative access. 
  2. In Release 15.3 or higher, test the reports by clicking Home, Reports and Jobs and launching any default report. 
  3. If you encounter the RPT-0023 error, folder-level access permissions have been reset. 
  4. To fix this problem, change the folder-level access for ROLE_USER from
    No Access
    to
    Read Only
    .