Upgrade Jaspersoft and Migrate Advanced Reporting Content

CA PPM SaaS customers enjoy an automatic upgrade to JasperReports 6.4.2.
ccppmop151
CA PPM SaaS customers enjoy an automatic upgrade to JasperReports 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.1. You will upgrade to CA PPM 15.5 in 2018. At that time, your reporting solution will also be upgraded.
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 (ca_ppm_jaspersoft_6.4.2_5.4.2.15.zip) can be used to install Jaspersoft and integrate it with CA PPM for reporting.
JasperReports Server 6.4.2 is a maintenance release that includes improvements requested by customers. For a summary of the changes, see CA PPM 15.1.0.10 and Jaspersoft 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 export, import, and can migrate Advanced Reporting content. See Export, Import, or Migrate Advanced Reporting Content.
If you have already installed
CA PPM
 with JasperReports Server 6.2.1, skip to
Apply the JasperReports Server Cumulative Patch
. If you are currently on JasperReports Server 6.1.0, proceed with the steps documented below under
Upgrade the Jaspersoft Server
.
Upgrade to JasperReports Server 6.4.2
JasperReports Server can be deployed as a standalone application or in a cluster for high concurrency. Clustered JasperReports Server Instances will use thread-safe access to their private repository database. As a result, any number of JasperReports Server instances can share the same repository thus present the same environment to users.
When JasperReports Server is deployed in a cluster, we recommend that you dedicate one or more JasperReports Server instances in the cluster to process the execution of scheduled reports. These dedicated instances will share the same repository but will not be part of the load balancer to serve web requests, such as executing reports through the UI and/or exploring data through ad hoc views.
For standalone deployment where only a single instance of JasperReports server is available, the instance will process report scheduling as well serve normal web requests, such as report execution through the UI and/or exploring data through ad hoc views.
We are providing a mechanism to make dedicated JasperReports server instances as scheduler instances, and the instances that are part of the load balancer to serve web requests as non-scheduler instances.
PRE-REQUISITES
----------- -------------------------------------
- Set the JAVA_HOME environment variable and ensure the correct Java8 executable is present in the PATH environment variable.
- Create a new Jaspersoft Database/Schema before starting the installation and upgrade.
The following components included in the installer are updated: Apache Tomcat 8.5.20, Oracle JDK 8 version 1.8.0_144 (8u144), PostgreSQL 9.3.18, and Spring Framework 3.2.18.
For the Upgrade:
- Export the Jaspersoft content to a zip file (exported from Jaspersoft UI only).
- Take a backup of the existing Jaspersoft instance (the Webapp) and database (Database/Schema).
 
INSTALLATION/UPGRADE
------------------------------------------------
1. Unzip ca_ppm_jaspersoft_<Jaspersoft Version>_<CA PPM Jaspersoft Version>.zip to a folder.
(Example: ca_ppm_jaspersoft_6.4.2_5.4.2.zip, it is recommended to unzip the installer in the root directory of the path to avoid a long path exception)
2. a) If on Windows:
Run install.bat
b) If on Linux:
Run chmod u+x install.sh
Run install.sh
------------------------------------------------
Select Installation Type
1) New : This installs Jaspersoft as a brand new installation
2) Upgrade : This upgrades the existing Jaspersoft installation
Enter Apache Tomcat 8.5 Directory : Location on the machine where Tomcat7 is installed
Enter Jaspersoft Web App Name : web app name refers to the name of the folder where Jaspersoft is being deployed E.g.: reportservice
Enter Jaspersoft Web App Port : port on which Jaspersoft should run - default 8080
Email configuration
1) Y : To setup email configuration
a) Enter Mail Server Hostname : Hostname of the mailserver - E.g.: mail.localhost.com
b) Enter Mail Server Port : Port number of mailserver - E.g. :25
c) Enter Sender Email Protocol : Protocol that mail server supports - Currently, Jaspersoft supports smtp and smtps
d) Enter Sender Email Username : Username of the Mail Sender- E.g.: test
e) Enter Sender Email Password : Password of the Mail Sender- E.g.: password123
f) Enter Sender Email Address : Sender Mail Address - E.g.: [email protected]
2) N : To skip email configuration
Select the Installation Mode
1) Standalone : For standalone servers
2) Cluster : For cluster-based deployments
If the cluster mode is selected:
1) Primary Node : Same as standalone installation
2) Additional Node (Web-app deploy only) : Just deploys the web app only and uses primary node database/schema
Do you need a dedicated Jaspersoft instance as a report scheduler instance?
1) Yes : Choose this option if you want to have a separate scheduler instance.
2) No : Choose this option if you do not want a separate scheduler instance. If running only a single instance of JasperReports server, then select 'no' when being prompted on separating the scheduler instance as a dedicated instance. - If the answer is 'no', the installer will perform the necessary configuration changes to make the current instance a non-scheduler instance. To get full advantage of this configuration, ensure the non-scheduler instances are part of the load balancer.
If 'Yes' is selected in the previous step:
Do you want to make the current instance as a report-scheduler-only instance?
1) Yes : Choose this option to have the installer perform the necessary configuration changes and make the current instance a scheduler instance.
2) 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.
Select DB Server type
1) MSSQL
2) Oracle
If MSSQL is selected:
MSSQL Server Hostname : Enter MSSQL server hostname (E.g.: HOSTNAME)
Do you want to use a named instance?
a) Yes : Choose this if you are using a MSSQL server named instance for the Jaspersoft installation.
b) No : Choose this if you are using a default MSSQL server with a static port number.
If Yes is selected:
i) Enter the MSSQL Server Instance Name : The named instance configured on the MSSQL server
ii) Enter the Jaspersoft Database Name : Jaspersoft database name - default: PPM_JASPERSOFT
iii) Enter the Jaspersoft Database Username : Jaspersoft Username - e.g.: PPM_JASPERSOFT
iv) Enter the Jaspersoft Database Password : Jaspersoft Password
If No is selected:
i) Enter the MSSQL Server Port Number : Database port on which MSSQL server is running - E.g.: 1433
ii) Enter the Jaspersoft Database Name : Jaspersoft database name - default: PPM_JASPERSOFT
iii) Enter the Jaspersoft Database Username : Jaspersoft Username - E.g.: PPM_JASPERSOFT
iv) Enter the Jaspersoft Database Password : Jaspersoft Password
If Oracle is selected
1) Oracle Standalone
2) Oracle Cluster (RAC)
If Oracle Standalone is selected:
a) Enter the Oracle Database Hostname : The Oracle server hostname - E.g.: HOSTNAME
b) Enter the Oracle Database Port Number : Database port on which oracle is running - E.g.: 1521
c) Enter the Jaspersoft Database Username : Jaspersoft database - E.g.: PPM_JASPERSOFT
d) Enter the Jaspersoft Database Password : Jaspersoft password
e) Enter the Oracle SID Name : Oracle SID - E.g.: <ORACLESID>
If Oracle Cluster (RAC) is selected:
a) Enter the Oracle Database Hostname : The Oracle server hostname - E.g.: HOSTNAME
b) Enter the Oracle Database Port Number : Database port on which oracle is running - E.g.: 1521
c) Enter the Jaspersoft Database Username : Jaspersoft database - E.g.: PPM_JASPERSOFT
d) Enter the Jaspersoft Database Password : Jaspersoft password
e) Enter the Oracle Service Name : Oracle SERVICENAME - E.g.: <SERVICENAME>
3. Confirm the properties that were entered and wait until the installation completes.
4. After the Tomcat service starts, log in to http://<MACHINE_NAME>:<PORT>/<JASPERSOFT_WEB_APP_NAME>
For example, http://jaspersoftserver:8080/reportservice/ using the credentials superuser/superuser.
Upgrade the Jaspersoft Server to the Minimum Supported Version of Jaspersoft 6.2.1
Cumulative Patch 6.2.1_5.2.1.4 for CA PPM 14.3, 14.4, 15.1, 15.2, and 15.3
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 
CA PPM
 release. You then provide this content zip when prompted during the Jaspersoft upgrade process.
 
Follow these steps:
  1. Verify that the JasperReports Server is configured.
  2. Verify that 
    CA PPM
     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 upgrade.
  4. Export the server-level data from the JasperReports 6.1.x server. In CSA, select Manage, Server Settings, Export. The <content>.zip file is created in the specified folder.
  5. Download the latest JDK 8 and Tomcat 7 software from their respective vendors. Set JAVA_HOME and JRE_HOME and verify that the correct java8 and jre8 executables are 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. Create a JasperReports Server database/schema with a new name before starting the upgrade.
  8. If this is the second attempt at an upgrade, perform the following actions before starting the upgrade process again:
    1. Delete the <Tomcat7>\<WebApp> folder, if it was created.
      Examples:
      (Windows) rmdir <Tomcat7>\webapps\<reportservice>
      (Linux) rm -rf <Tomcat7>/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.
  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.
      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 latest 
    ca_ppm_jaspersoft_6.2.1_x
    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). Note: 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 the JasperReports Server 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. 
        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?
    Choose
    Yes
    if you do not want to have a separate scheduler instance.
    Choose
    No
    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.
  20. Do you want to make the current instance as report scheduler only instance?
    Choose
    Yes
    to have the installer perform the necessary configuration changes and make the current instance a scheduler instance.
    Choose
    No
    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.
  21. 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 version
    11.2.0.4 or higher
    12.1.0.2 or higher
     
    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 version
    11.2.0.4 or higher
    12.1.0.2 or higher
     
    Oracle Service Name
    Oracle service name (for example, <SERVICENAME>).
  22. To continue, choose
    Yes
    .
  23. Provide the Absolute Path of the Jaspersoft content zip file. This is the absolute path to the exported content zip from the previous Jaspersoft.
  24. Verify the properties that you entered and wait until the installation completes.
 
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.
 
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 
    CA 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 
    CA 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
To authenticate 
CA 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 [[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 
CA 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 to use the Restore Domains Job. Additionally, customers must apply the Jaspersoft Server Cumulative Patch 6.2.1_5.2.1.2.6. 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 (also available on the CA PPM 15.1.0.10 and Jaspersoft Patch README Files page).
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).
  4. Download the JasperReports Server cumulative patch zip file.
    1. Log in to CA Support.
    2. In the Download Center, specify your product and release.
    3. Search for the latest 
      ca_ppm_jaspersoft_patch_x.zip
       file. You might have to download and mount the ISO image file first, and then extract the ZIP archive from inside it.
    4. Save the zip file to a local directory.
  5. Unzip the contents of the zip file to a new patch folder (for example, 
    /opt/jasperreports/patch
     for UNIX or 
    C:\Jasperreports\Patch
     for Windows).
  6. Open a command prompt and complete the following steps:
    1. Go to the bin folder under the folder where you extracted the patch (for example, 
      /opt/jasperreports/patch/bin
       for UNIX or 
      C:\Jasperreports\Patch\bin
       for Windows).
    2. Provide execute permission to the installation scripts.
                     UNIX/Linux
: Run the following command:                           [[email protected] bin]#chmod u+x *
                    Windows: 
Not applicable
     
4. Run the following commands to start the patch installation in interactive mode.
                    UNIX/Linux: 
Run the following command:                        [[email protected] bin]#sh ./install.sh interactive
                    Windows: 
Run the following command:                        C:\Jasperreports\Patch\bin>install.bat interactive     5. Enter the requested information.
    • Enter Tomcat Home Directory
      . The location where JasperReports Server is deployed and Tomcat is installed.
    • Enter Jaspersoft Server web-application Name
      . 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
      . The default value is “reportservice”. To use the default value, press the Enter key.
    • Select Installation Mode
      .
       
      The default value is “Standalone”. To use the default value, press the Enter key. The modes include the following options:
      • Standalone for a standalone server or for a primary node in a cluster.
      • Cluster for secondary nodes in a cluster.
Post-Patch Installation
Complete the following actions after installing the JasperReports Server cumulative patch:
  • Clear the application server (Apache Tomcat Server) 
    temp
     directory.
  • Clear the application server (Apache Tomcat Server) 
    work
     directory.
  • Start the Apache Tomcat Server where JasperReports Server is deployed.
  • Clear the browser cache on the client.
Verify the JasperReports Server Cumulative Patch Installation
Complete the following steps to verify that the JasperReports Server cumulative patch installation was successful.
Follow these steps:
  1. Start the JasperReports Server, if it is not already started.
  2. Open the following URL:
    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 following credentials:
    Username: superuser
    Password: superuser
  5. Open the following URL:
    http://<domain_name>:<portnumber>/<jasperwebcontext>/version.htm
  6. Verify the installed patch version:
    For example, CA PPM Jaspersoft Release Patch Version = 5.1.0.2
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.