Overlay Upgrade

This chapter describes the overlay process for upgrading to JasperReports Server 9.0.0 and contains the following sections:

Introduction to the Overlay Upgrade

The overlay upgrade procedure is available only for the JasperReports Server Commercial edition installed with the WAR file and only with the Apache Tomcat application server.

The overlay upgrade supports upgrading from JasperReports Server versions 8.0 and later to JasperReports Server 9.0.0.

Although the overlay upgrade does offer a rollback feature, you should always back up your database and application before upgrading.

Upgrade Steps Overview

These are the general steps used in this section:

(The overlay tool automatically takes back up of your war file and ask if you have backed up your database.)

The overlay upgrade procedure helps you to identify any modifications or extensions you have made to your JasperReports Server instance.

Plan Your Upgrade

See Planning Your Upgrade to determine if any customizations you've made to your existing version of JasperReports Server are affected by changes to the updated version.

Back Up Your JasperReports Server Instance

First back up your JasperReports Server WAR file and Jasperserver database so you can restore them if necessary. Perform these steps from the command line in a Windows or Linux shell.

Back up your JasperReports Server War File

Procedure
1. Create a folder where you can save your jasperserver-pro war file, for example C:\JS_BACKUP or /opt/JS_BACKUP.
2. Copy <tomcat>/webapps/jasperserver-pro  to  <path>/JS_BACKUP.

Back up your Jasperserver Database

Procedure
1. Create a folder (if you did not do so in the step above) where you can save your Jasperserver database, for example C:\JS_BACKUP or /opt/JS_BACKUP.
2. Run the following commands for PostgreSQL:
   • PostgreSQL

     cd <path>/JS_BACKUP
     pg_dump --username=postgres  jasperserver  >  js-db-dump.sql

Back up your JasperReports Server Keystore

Unpack the Overlay Upgrade Package

The overlay upgrade package comes in a file named:js-jrs_9.0.0_overlay.zip.

overlay

This document refers to this folder location as:

<overlay-folder>

Check for JDBC Driver (Oracle, SQL Server, DB2)

JasperReports Serveruses the JDBC drivers for the Oracle, SQL Server, and DB2 commercial databases. If you want to use a different JDBC driver, you need to copy it to the correct location. If you use Oracle or DB2, you must also use your existing version of the db.template.properties file. See Working With JDBC Drivers for more information.

Configure the Properties in the default_master.properties File

Before running the overlay upgrade, copy the default_master.properties file from the existing JRS buildomatic directory to the Overlay buildomatic directory. Configure the properties specific to the installation type:

Run the Overlay Upgrade

The overlay upgrade works only with the Tomcat application server. It supports only the certified repository databases. You can perform the overlay upgrade whether you have local customizations or not.

Procedure
1. Stop the Tomcat application server.
2. Make sure that your database is running.
3. Make sure that the user running the overlay commands is the same user that installed the server.
4. Run the following commands:

   cd <overlay-folder>

   Windows:overlay install

   Linux:./overlay install

5. You are prompted to specify a path to a working folder:
   • You can accept the default or specify an alternate folder.
   • Press enter to accept the default ../overlayWorkspace.
6. You are prompted to take a back up of your Jasperserver database. If you have already backed up your database, choose "y" to continue. If you have not yet backed up your database, choose "n" to exit the overlay and create a backup.
7. You are prompted to shut down your Tomcat instance:

• You can stop Tomcat now if you have not already done so.
• Choose "y" for yes to continue.

• In general, it is recommended to exit the overlay procedure and make sure that the keystore is in the proper location, then rerun the overlay as described below.
• Alternatively, update the current location of the keystore in the keystore.init.properties file at the following locations:
  • .../WEB-INF/classes/keystore.init.properties
  • .../buildomatic/keystore.init.properties
  • .../buildomatic/conf_source/iePro/keystore.init.properties
• If you continue and create a keystore, then the overlay proceeds but your repository is corrupted and users are unable to log in. In this case, you need to export manually the server's repository with a custom key, then import the key before importing the repository, as described inEncryption Keys.

Specify the path for your default_master.properties file, which is present in the Overlay buildomatic directory.

When the overlay upgrade has finished, start Tomcat, and log in to test the upgraded JasperReports Server.

If the upgrade was successful, you see BUILD SUCCESSFUL on the command line.

For the Split upgrade, after the upgrade is done, to transfer the data (Audit, Access, and Log monitoring data) to the audit database from the Jasperserver database, run the following command:

• Windows: transfer-audit-data.bat
• Linux and Mac OSX: ./transfer-audit-data.sh

The data is transferred to the audit database and the tables are deleted from the Jasperserver database. Rerun the command if there is any interruption in the data transfer process, it resumes the transfer process from where it was interrupted in the previous run.

Rerun the Overlay Upgrade

If you exit the overlay install for any reason, you can rerun the overlay by simply running the same command:

overlay install

By default, the overlay runs in resume mode (resumeMode=true). This means that your answers to previous prompts are remembered.

If you want to rerun the overlay "from scratch", run the following command:

overlay install -DresumeMode=false

For more information on the overlay options, run:

overlay help

Rollback Procedure

If you encounter an error with the overlay upgrade, use the following rollback procedure:

1. Stop Tomcat.
2. Run the following command:

   overlay rollback

3. Specify the path to the working folder:

   The default is ../overlayWorkspace

4. The tool asks if you have rolled back your JasperReports Server database:

   The default is no

   You are manually required to restore your database.

5. When the tool has finished, restore your database (see below), start Tomcat, and test JasperReports Server.

To restore your JasperReports Server Database

For example, C:\JS_BACKUP or /opt/JS_BACKUP.

cd /opt/JS_BACKUP 
pg_restore --username=postgres  jasperserver  <  js-db-dump.sql

To restore your JasperReports Server Keystore

For example, C:\JS_BACKUP or /opt/JS_BACKUP.

Starting and Logging into JasperReports Server 9.0.0

Start your application server. Your database should already be running.

Clearing Your Browser Cache

Before you log in, make sure you and your end users clear the browser cache. JavaScript files, which enable the UI elements of JasperReports Server, are typically cached by the browser. Clear the cache to ensure that the newer files are used.

Logging into JasperReports Server

Log in using the following URL, user IDs, and passwords:

URL: http://localhost:8080/jasperserver-pro

superuser

<your-password>

jasperadmin

<your-password>

Your JasperReports Server instance has now been upgraded to 9.0.0. If you have startup or login problems, refer to the Troubleshooting appendix of the JasperReports Server Installation Guide.

Additional Tasks to Complete the Upgrade

Perform these tasks with the application server shutdown.

Handling JasperReports Server Customizations

If you made modifications to the original JasperReports Server application, you need to copy manually configuration changes, like client-specific security classes or LDAP server configurations, from your previous environment and integrate them with your upgraded environment. These configurations are typically found in the files at the WEB-INF/ location, for example, applicationContext-*.xml, *.properties, *.js, *.jar, and so on.

Clearing the Application Server Work Folder

Application servers have work folders where JasperReports Server files are compiled and cached and other objects are stored. When you update the WAR file or license, the buildomatic deploy-webapp-pro target should automatically clear the application server’s work directory, but it is a good practice to double-check. A permission problem, or some other problem, could prevent the clearing of the work folder.

To clear the work folder in Tomcat

Clearing the Application Server Temp Folder

JasperReports Server uses caching to speed operations within the application. Caching files are created and stored in the application server, usually in a temp folder. Clear this temp folder to avoid any post-upgrade conflicts.

To clear the temp folder in Apache Tomcat

Clearing the Repository Cache Database Table

In the Jasperserver database, compiled JasperReports Library resources are cached in the JIRepositoryCache table for increased efficiency at runtime. Because the JasperReports Library JAR is typically updated with each new release, old cached items can get out of date and cause errors at runtime. If you encounter errors that mention a JasperReports Library "local class incompatible", check your repository cache table. In summary, you can clear your Jasperserver database cache table as part of this upgrade process whether there are errors or not.

To clear the repository cache database table manually, run a SQL command similar to the one shown below:

update JIRepositoryCache set item_reference = null;
delete from JIRepositoryCache;

Running Overlay Upgrade a Second Time

If you run the overlay upgrade a second time, the overlay logic asks if you want to resume the last run of the overlay, so that your previous answers to questions are remembered and reused.

The overlay procedure asks:

"We have detected that the overlay install was already run. Do you want to resume your last run? The default is 'y' ([y], n):"

• Choose "y" for yes if you do not want to change any information previously given to the overlay.
• Choose "n" for no if you would like to enter new or different information.

One reason for entering "n" for no would be if you did not give a valid path to your default_master.properties file the first time you run the overlay.