Upgrade Guide to ReportServer 3.0.3-beta

In this guide we describe how to upgrade ReportServer 3.0.2 installations (RS3.0.2-5855) to ReportServer 3.0.3-beta. This guide is valid for both ReportServer Enterprise Edition and ReportServer Community Edition as well as for manual installations and Bitnami installer installations. Note that this guide is only valid for upgrades from version 3.0.2.

If you want to perform a new installation: You can install 3.0.3-beta analogously to 3.0.2, as described in the installation guides: Linux or Windows. Instead of decompressing RS3.0.2-5855.zip, decompress RS-3.0.3-NIGHTLY.zip to the tomcat webapps directory, and then perform the database initialization as described in the section "Initialize the ReportServer Database" of the corresponding guide. Note that the DDL scripts are only available in RS-3.0.3-beta-20170803 and above.

Since this is a beta release, install only in a test system. Backup all your data before installing.

In ReportServer 3.0.3, the Saiku and Mondrian libraries were upgraded to 3.8 and 4.3.0.1, respectively. These are in most of the cases not backward compatible. This means the following:
  • Pivot table variants: you have to create new variants, configure them, and save them again.
  • Mondrian datasources: if your Mondrian XML schema is defined in reportserver, you shall upgrade the schema to version 4, i.e. it must contain: "<Schema name="YourSchema" metamodelVersion="4.0">". More information here.

In order to use reportserver-3.0.3-beta with Oracle, the following jars (or newer versions) are needed: ojdbc6.jar, orai18n.jar, xdb6.jar and xmlparserv2.jar. These are needed because of the new XML/JSON support. Please download and copy them to the WEB-INF/lib directory. Note: we recommend to use ojdbc7.jar or newer because of this jdbc driver incompatibility with null parameters in BIRT reports.

The Upgrade in a Nutshell

The upgrade basically consists of replacing the webapp files of ReportServer, that is, the files under TOMCAT/webapps/reportserver (or TOMCAT/webapps/ROOT, depending on your installation) are removed and the freshly downloaded files are copied there instead. In the following we explain the upgrade in detail

Preconditions

In this upgrade guide we assume that you are working with an externalized configuration directory as described in Chapter 5 of the configuration guide. We are also assuming that you use Tomcat as application server. If you installed ReportServer 3.0.2 via the Bitnami installer or followed the best practice tutorial for Linux or Windows. If you are not yet using an external configuration directory, this is a good point to change your setup. As for this upgrade, the main difference is that you do not need to worry about your configuration changes, but can simply do a one-step copy and paste upgrade.

For Bitnami users: We here describe how to upgrade ReportServer without upgrading the entire Bitnami stack.

The Upgrade

To upgrade ReportServer, follow these steps.

  1. Download ReportServer 3.0.3-beta (download links are available on our 3.0.3-beta page.).
  2. Stop your ReportServer instance.
  3. Go to the webapps directory of Tomcat and there to the directory in which ReportServer is installed. If you used the Bitnami installer this is
    INSTALLATION DIRECTORY/apache-tomcat/webapps/reportserver
    If you followed the installation tutorial this would be
    TOMCAT DIRECTORY/webapps/ROOT
    To check that you have the right folder confirm that this folder contains amongst others a file called ReportServer.html and a folder called ddl.
  4. Clear out the above folder, that is, remove the entire contents. All your drivers will be deleted, since the whole directory is being replaced by the downloaded one. Backup them to easily add them later. These are found on the WEB-INF/lib directory of your reportserver installation.
  5. Unzip ReportServer 3.0.3-beta and copy everything to the now empty folder. The structure should be identical to before, that is, you should once more find a file called ReportServer.html and a folder called ddl (Note that the DDL scripts are only available in RS-3.0.3-beta-20170803 and above).
  6. This step is only necessary if you have already installed a reportserver-3.0.3-beta release previous than the RS-3.0.3-beta-20170803 build: Execute the following sql statements to downgrade your reportserver database. This is needed because, since RS-3.0.3-beta-20170803, the process is automated. You may have to change them, depending on the database you are using.
      
    alter table RS_SAIKU_REPORT drop column hide_parents;
    alter table RS_SAIKU_REPORT_A drop column hide_parents;
    
    alter table RS_TABLE_REPORT drop column hide_parents;
    alter table RS_TABLE_REPORT_A drop column hide_parents;
    
    alter table RS_SCHED_ACTION_MAIL_REPORT drop column compress; 
    							
  7. Completely delete your browser's cache to ensure you will get the newest files.
  8. Start up Tomcat

This completes the Upgrade to ReportServer 3.0.3-beta. To ensure that installation was successful have a look at your Tomcat log files. Startup should look similar to the following

  _____                       _    _____                            ______       _                       _          
 |  __ \                     | |  / ____|                          |  ____|     | |                     (_)         
 | |__) |___ _ __   ___  _ __| |_| (___   ___ _ ____   _____ _ __  | |__   _ __ | |_ ___ _ __ _ __  _ __ _ ___  ___ 
 |  _  // _ \ '_ \ / _ \| '__| __|\___ \ / _ \ '__\ \ / / _ \ '__| |  __| | '_ \| __/ _ \ '__| '_ \| '__| / __|/ _ \
 | | \ \  __/ |_) | (_) | |  | |_ ____) |  __/ |   \ V /  __/ |    | |____| | | | ||  __/ |  | |_) | |  | \__ \  __/
 |_|  \_\___| .__/ \___/|_|   \__|_____/ \___|_|    \_/ \___|_|    |______|_| |_|\__\___|_|  | .__/|_|  |_|___/\___|
            | |                                                                              | |                    
            |_|                                                                              |_|                    

Version: RS3.0.3-2e81abf3 2017-08-03-15-15-52
Code Version: 2016-05-29-17-55-24
Java Version: Oracle Corporation Java HotSpot(TM) 64-Bit Server VM 25.91-b14 (1.8)
VM Args: -agentlib:jdwp=transport=dt_socket,suspend=y,address=localhost:55866 -Xmx2g -Drs.configdir=/opt/reportserver -Dfile.encoding=UTF-8
rs.configdir: /opt/reportserver (OK)

### DB Config ###
hibernate.dialect: net.datenwerke.rs.utils.hibernate.MySQL5Dialect (OK)
hibernate.connection.driver_class: com.mysql.jdbc.Driver (OK)
hibernate.connection.url: jdbc:mysql://127.0.0.1:3309/bitnami_reportserver (OK)
hibernate.connection.username: bn_reportserver
hibernate.connection.password: **********
hibernate.default_schema: 

Connection Test: OK
Schema Version: RS3.0-8

16:27:30.458 INFO  n.datenwerke.rs.EnvironmentValidator - Performing database update RS3.0-8 -> RS3.0-9
16:27:34.065 INFO  n.datenwerke.rs.EnvironmentValidator - Running script RS3.0-9-MySQL5_UPDATE.sql
16:27:35.175 INFO  n.datenwerke.rs.EnvironmentValidator - Validating database schema...

The important bit is the the third to last row which indicates that the database upgrade script was successfully executed. Note that this only happens once after the upgrade and that from then on any startup would show an updated schema version, that is:

Schema Version: RS3.0-9

Adapt Internal Configuration

An optional step is to adapt the internal configuration files located in ReportSever's file server (folder etc). For an overview of the changes see the release notes.

Upgrade/Install Demo Data

A final optional step is to install or upgrade your existing demo data. For this, check this link. This step will delete all your existing data in the system.

Happy Reporting