|•||Upgrade Using the Overlay Method|
|•||Upgrade from 6.x to 6.4.3|
|•||Upgrade from Older Versions|
|•||Upgrade from Community Project|
|•||Important Upgrade Information|
You can upgrade directly to 6.4.3 if your instance is one of the following:
To upgrade, start with the WAR File Distribution ZIP: TIB_js-jrs_6.4.3_bin.zip
Downloaded it from
The recommended upgrade procedures are fully described in the JasperReports Server Upgrade Guide.
If you are upgrading from certain versions of JasperReports Server, such as 4.5 or earlier, 5.6,
Between certain versions of the server, we have changed the repository database in order to add new functionality:
|•||There are jasperserver repository database changes between 6.0.x and 6.1.x as well as between 6.1.x and 6.2.0.|
|•||There are no database changes between 6.2.0 and 6.2.1.|
|•||There are database changes between 6.2.x and 6.3.0.|
|•||There are database changes between 6.3.x and 6.4.0.|
|•||There are no database changes between 6.4.0 and 6.4.2 or 6.4.3.|
Upgrade Using the Overlay Method
These instructions apply only to instances that are deployed in Tomcat; the overlay method doesn't support other application servers.
The 5.1 release added an improved package for upgrading between versions called the Overlay Upgrade.
This package supports a new procedure for upgrading from JasperReports Server 4.0 and above. It can preserve and give execution-time feedback on modified files and customizations found in your JasperReports Server instance. This allows the upgrade to preserve your customizations and gives you visibility into which files changed. This new procedure also supports rollback to put your original web application instance back in place.
This package is only implemented and certified to work with the Tomcat application server. All certified repository databases are supported.
Start by downloading the Overlay Upgrade package from
To start your overlay upgrade:
|1.||Unzip the package and open a command shell to its root. Make sure to stop your Tomcat instance. Then enter:|
This initiates the upgrade operation.
|2.||You are prompted for a working folder; accept the default.|
You are prompted for the path to a default_master.properties file from your previous JasperReports Server installation.
|3.||Enter the path.|
The overlay upgrade can now execute.
|4.||Once the overlay upgrade is complete (and you have resolved any file conflicts), restart Tomcat.|
For information on the overlay upgrade functionality, see the JasperReports Server Upgrade Guide.
Upgrade from 6.x to 6.4.3
The recommended procedure for upgrading from 6.x is described in the JasperReports Server Upgrade Guide. Run this procedure from the command line. In summary:
|1.||Copy the properties file:|
cp sample_conf/<dbType>_master.properties default_master.properties
|2.||Using a text editor, edit default_master.properties to add your application server and database server properties.|
|3.||Run the install .sh or .bat file:|
Upgrade from Older Versions
This upgrade procedure lets you upgrade from any of the JasperReports Server versions listed in this section's introduction (versions 4.x through 6.3.x).
The recommended procedure is described in the JasperReports Server Upgrade Guide. This procedure is run from the command line. In summary:
|1.||Export your existing JasperReports Server repository data, either using the buildomatic/js-export.sh/bat command (for example, ./js-export.sh --everything --output-zip my-export.zip), or by exporting directly from the web UI).|
|2.||Change directories to the buildomatic directory (for example, cd <unpacked-dir>/buildomatic).|
|3.||Copy the master properties file (for example, cp sample_conf/<dbType>_master.properties default_master.properties).|
|4.||Edit the default_master.properties file to add your application server and database properties (for example, ./js-upgrade-newdb.sh <path>/my-export.zip, or /.js-upgrade-newdb.bat <path>/my-export.zip).|
Upgrade from Community Project
If your current instance is the Community version, you can follow the JasperReports Server Upgrade Guide to upgrade to the Commercial version.
Important Upgrade Information
This section describes special upgrade requirements for certain versions of the server:
|•||Changes in the 6.2.1 Release|
|•||Changes in the 6.1.0 Release|
|•||Changes in the 6.0.x Releases|
|•||Changes in the 5.6.0 Release|
For additional information on planning for your upgrade, see Planning Your Upgrade in the JasperReports Server Upgrade Guide.
Changes in the 6.2.1 Release
JasperReports Server provides new and updated drivers for various databases. In the 6.2.1 release, the previous connector for Impala that was available on the Jaspersoft community website was replaced with two new options:
|•||TIBCO Impala JDBC driver (also called Progress)|
|•||Simba JDBC driver (Cloudera-endorsed JDBC interface)|
For more information, see the JasperReports Server Upgrade Guide.
Changes in the 6.1.0 Release
The new look-and-feel of JasperReports Server introduced in the 6.1.0 release required several changes to the structure of themes. If you have customized your theme, you must apply those customizations to a new theme.
For more information, see the JasperReports Server Upgrade Guide.
Changes in the 6.0.x Releases
Starting in the 6.0.x releases, the server now incorporates a more recent version of the underlying Spring Security framework. We now use Spring Security 3. If you are upgrading from a previous version of JasperReports Server, you may need to take additional steps to accommodate the file structure of the new version of Spring. This is particularly the case if you have custom LDAP or SSO configured for the server. For more information, see the JasperReports Server External Authentication Cookbook.
Domain Security Changes
In previous versions of JasperReports Server, Domain security could be applied by checking user's attributes via the authentication.principal.attributes method of the REST API. Now, the authentication.principal.attributes method is no longer supported and should be discontinued in production and test use. Instead, use the attributesService. For more information, refer to the JasperReports Server REST API Reference, as well as the JasperReports Server Security Guide section about updating your Domain security file to use attributesService.
Changes in the 5.6.0 Release
The 5.6.0 version included changes that may require you to take additional steps during upgrade:
|•||JDBC Drivers: The 5.6.0 version did not include JDBC drivers for some of the typical commercial databases (Oracle, Microsoft SQL Server, or DB2). In 5.6.1 and forward, we have included drivers for these data sources; the manual steps to add these drivers are no longer necessary. For more information, see the documentation; in particular:|
|•||Find information about working with drivers during installation in the JasperReports Server Installation Guide.|
|•||Find information about working with drivers during upgrade in the JasperReports Server Upgrade Guide.|
|•||Find information about working with drivers in the web UI in the JasperReports Server Administrator Guide.|
|•||Changes to OLAP engine: Due to a change between versions of the OLAP engine, if you use Jaspersoft OLAP's XML/A functionality to connect to a remote JasperReports Server's XML/A sources in versions previous to 5.6.x, you must take additional steps to complete your upgrade to 5.6.x and later versions. For information, see JA-926 in Current Known Issues.|