This chapter describes the recommended procedure for upgrading from JasperReports Server:

3.7, 3.7.1, 4.0, 4.0.1, 4.1, 4.2, 4.2.1, 4.5, 4.5.1, 4.7, 4.7.1, 5.0, 5.1, 5.2, or 5.5

to JasperReports Server 6.0.

The upgrade procedures described in this chapter use the JasperReports Server WAR File Distribution ZIP release package and the included buildomatic scripts.

The procedure in this chapter can also be used to upgrade JasperReports Server 5.6 or 5.6.1 to 6.0. However, we recommend you use the procedure in Upgrading from 5.6 to 6.0.

In this chapter the examples shown will use JasperReports Server 5.5 as the version being upgraded from.

This chapter contains the following sections:

Upgrade Steps Overview

These are the general steps used in this section:

If your current instance of JasperReports Server has any custom modifications or extensions, keep track of these and re-integrate them into your 6.0 instance after upgrading.

Planning Your Upgrade

There is a planning chapter you should review in order to see if there are changes which will affect your deployment. This chapter can be found here: Planning Your Upgrade .

Back Up Your JasperReports Server Instance

First you must backup your JasperReports Server WAR file and jasperserver database so that they can be restored in case there is a problem with the upgrade. These steps are performed from the command line in a Windows or Linux shell.

The following backup example is for Tomcat with the PostgreSQL or MySQL database. For other databases, consult your DB administration documentation for back up information.

Back up your JasperReports Server War File:

Back up your jasperserver Database:

cd <path>/JS_55_BACKUP

pg_dump --username=postgres  jasperserver  >  js-db-5.5-dump.sql

cd <path>/JS_55_BACKUP

Exporting Current Repository Data

You need to export your old repository data, for example your 5.5 repository data, using the JasperReports Server export utility. You can export in the following ways:

Using Buildomatic Scripts to Export Data

If you configured buildomatic and your default_master.properties file for export as described in the JasperReports Server Administrator Guide, you can export your repository data. For example, to export 5.5 repository data, use the following commands:

cd <js-install-5.5>/buildomatic

js-ant.bat export-everything-ce -DexportFile=js-5.5-export.zip[/code]                    

./js-ant export-everything-ce -DexportFile=js-5.5-export.zip[/code]                    

Using the js-export Script to Export Data

To use the js-export-ce.bat/.sh script, navigate to the buildomatic folder, for example, <js‑install‑5.5>/buildomatic. If you are using the PostgreSQL database then the js-export script should already be configured to run. If you are using a different database, or you have changed database passwords, you may need to update the js‑export configuration.

The import-export utility for JasperServer 3.7 needs additional configuration. For complete information on the standard import-export options refer to the JasperReports Server Administrator Guide.

Run the following commands:

cd <js-install-5.5>/buildomatic

js-export-ce.bat --everything --output-zip js-5.5-export.zip[/code]                    

js-export-ce.sh --everything --output-zip js-5.5-export.zip[/code]                    

Preparing the JasperReports Server 6.0 WAR File Distribution

Use the buildomatic js-upgrade scripts included in the 6.0 WAR file distribution ZIP release package to carry out the upgrade. Follow these steps to obtain and unpack the WAR file distribution ZIP file:

After you unpack the WAR File Distribution Zip, the resulting location will be known as:

<js-install-6.0>

Configuring Buildomatic for Your Database and Application Server

This upgrade procedure uses the js-upgrade-newdb-ce shell script.

This section shows example configurations for the PostgreSQL and MySQL databases.

Example Buildomatic Configuration

The upgrade configuration is handled by the default_master.properties file. Jaspersoft provides a sample configuration file for each database. You must specify your database credentials and your application server location, and rename the file to default_master.properties.

PostgreSQL Example

This example shows how to configure default_master.properties for PostgreSQL.

MySQL Example

This example shows how to configure default_master.properties for MySQL.

Upgrading to JasperReports Server 6.0

Now that your buildomatic scripts have been configured, you can complete the upgrade.

js-upgrade Test Mode

You can run the js-upgrade script in test mode using the test option. For example, on Window, enter:

cd <js-install-6.0>/buildomatic

js-upgrade-newdb-ce.bat test <path>/js-5.5-export.zip

In test mode, the js-upgrade scripts check your default_master.properties settings. The application server location and the capability to connect to the specified database are validated. Using test mode can help debug issues such as an incorrect database password. Your system will not be altered when executing the script in test mode.

Output Log Location

The js-upgrade script creates an output log that captures standard output and error output. If there are any problems during the execution of the script, or if you want to remember which options you chose, you can open the output log file.

The output log file is located here:

<js-install-6.0>/buildomatic/logs/js-upgrade-<date>-<number>.log

Errors

If you encounter errors during the js-upgrade script execution, first look at the output log to see if you can spot any errors. Also, refer to the Troubleshooting appendix of the JasperReports Server Installation Guide. The information in this appendix applies to js-upgrade scripts as well as js-install scripts.

If you need to modify values in your default_master.properties file, you can simply edit the file. When you run the js‑upgrade script again, the new values are used.

Starting and Logging into JasperReports Server 6.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

Your JasperReports Server instance has now been upgraded to 6.0. In the event of startup or login problems, refer to the Troubleshooting appendix of the JasperReports Server Installation Guide.

Additional Tasks to Complete the Upgrade

The tasks described below should be done when the application server is shutdown.

Handling JasperReports Server Customizations

If you made modifications or customizations to the original JasperReports Server application, JasperReports Server 5.5 for example, these configurations are typically found in the WEB-INF/applicationContext-*.xml set of files.

Configuration modifications, such as client-specific security classes or LDAP server configurations, need to be hand-copied from your previous environment and re-integrated into the upgraded environment.

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, the buildomatic deploy-webapp-ce target should automatically clear the application server’s work directory, but it’s 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 to support this functionality. Typically, these cached files are stored in a temp folder. Clear this temp folder to avoid any conflicts after the upgrade is complete. Typically, the temp folder used by an application server corresponds to the path pointed at by the java.io.tmpdir Java system property. For Apache Tomcat the temp folder is <tomcat>/temp.

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. In some cases, you may encounter errors running reports after an upgrade. Because the JasperReports Library JAR is typically updated with each new JasperReports Server release, old cached items can get out of date and thus cause errors at runtime. If you encounter errors that mention a JasperReports Library “local class incompatible,” check your repository cache table. You can clear your jasperserver database cache table whether there are errors or not as part of this upgrade process.

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

update JIRepositoryCache set item_reference = null;

delete from JIRepositoryCache;

Old Manual Upgrade Steps

This section has the older, manual upgrade steps that were in place before the js-upgrade shell scripts were implemented in the 4.0 release. These are provided in the following table as a reference, mainly for internal use. The js‑upgrade shell scripts execute these buildomatic targets “behind the scenes.” Jaspersoft recommends using the js-upgrade scripts described in the beginning of this upgrade chapter instead of these manual steps.

Older buildomatic upgrade steps for this chapter are the following (using a 5.5 upgrade as an example):