# Upgrading JReport Server

Upgrading a standalone JReport Server and an integrated JReport Server involves different processes while sharing some common steps. Both updated JReport Servers require converting the report resources in the old version in order to comply with the new server version.

Before upgrading, the old version JReport Server should be shut down.

## Upgrading in a standalone environment

JReport Server 13.5 provides two migration tools in `<install_root>\bin` folder, which can help you to convert all the resources on the previous version of JReport Server before version 6.0. Resources the migration tools cover include the security information (realm, user, group, protection, and ACL), report resources (catalog and reports), scheduled tables, completed tables, version and version tables, and other relevant information (such as fonts, NLS, and style groups).

Note: When installing the JReport Server 13.5 into the same directory as the old version, the report level resources in the old version will be maintained and not be replaced by the report resources of V13.5. For example, if you installed JReport Server 13.5 to `C:\JReport\Server13GA`, the backed up files of V13 GA will be maintained in `C:\JReport\ServerV13GA\bak\previous_version`, the removed patches and jar files will be maintained in `C:\JReport\ServerV13GA\bak\xxx\lib`, and the whole folder bin will be maintained in `C:\JReport\ServerV13GA\bak\xxx\bin`.

### Upgrading a version later than V13 GA (included) to V13.5

To upgrade a version later than V13 GA (included) to V13.5, take the steps below. Here is a case showing you how to upgrade V13 GA to V13.5, provided that the old JReport Server is located in `C:\JReport\Server13GA.`

1. Install JReport Server 13.5 to `C:\JReport\Server13GA`. In the Choose Installation Set screen, choose Typical Installation for Standalone Server and click Next.
2. In the prompted Installation Warning message window, choose Upgrading.
3. The installation turns to the List screen which shows the details of the upgrading, including the removed patches, the modified config files and the backup files.
4. Click Install in the Installation Summary screen. After the installation is complete, start JReport Server to check the upgraded version.

### Upgrading a version later than V6.0 (included) to V13.5

To upgrade a version later than V6.0 (included) to V13.5, take the steps below. Here is a case showing you how to upgrade V11.1 to V13.5, provided that the old JReport Server is located in `C:\JReport\Server11.1.`

1. Check the value of properties in dbconfig.xml which locates in `C:\JReport\Server11.1\bin` or back up the file firstly.
2. Install JReport Server 13.5 to `C:\JReport\Server11.1`. In the Choose Installation Set screen, choose Typical Installation for Standalone Server and click Next.
3. In the prompted Installation Warning message window, choose Yes.
4. In the System Database screen, input the property values according to the backed up dbconfig.xml file. Or check the Trial Database radio button, and replace dbconfig.xml file with the one you backed up.
5. In the List screen you can see the details of the upgrading, including the removed patches, the modified config files and the backup files.
6. Click Install in the Installation Summary screen. After the installation is complete, start JReport Server to check the upgraded version.

### Upgrading a version between V5.2 Build 590 (included) and V6 (excluded) to V13.5

You can make the upgrade using the migration tool MigrationV52.bat (MigrationV52.sh for Unix) that is available in the `<install_root>\bin` folder. This tool is used to convert all the resources of the versions between V5.2 Build 590 (included) and V6 (excluded) to the resources of JReport Server 13.5. If you install the new version to the same folder as the old one, the parameter can be omitted.

- Usage
  MigrationV52 [orgReportHome]
- Options
  - orgReporthome
    The reporthome of the original JReport Server. If this parameter is not provided, the reporthome of JReport Server 13.5 will be used as its value.

Case 1: Installing JReport Server 13.5 to a new folder (recommended)

1. Provided that the old JReport Server is located in `C:\JREntServer595`. Install JReport Server 13.5 to a new folder `C:\JReport\ServerV13.5`. DO NOT start the newly installed JReport Server.
2. In the DOS window, switch to `<install_root>\bin`, and run `MigrationV52 C:\JREntServer595`.

Case 2: Installing JReport Server 13.5 to the folder where the old version resides

1. Provided that the old JReport Server is located in `C:\JREntServer595`. Install JReport Server 13.5 to the same location. DO NOT start the newly installed JReport Server.
2. In the DOS window, switch to `<install_root>\bin`, and run `MigrationV52.bat`.

### Upgrading a version earlier than V5.2 Build 590 (excluded) to V13.5

You can do the upgrade using the migration tool MigrationBV52.bat (MigrationBV52.sh for Unix) that is available in the `<install_root>\bin` folder. This tool is used to convert all the resources of versions lower than V5.2 Build 590 to the resources of JReport Server 13.5. If you install the new version to the same folder as the old one, the parameter can be omitted.

- Usage
  MigrationBV52 [orgReportHome]
- Options
  - orgReporthome
    The reporthome of the original JReport Server. If the parameter is not provided, the reporthome of JReport Server 13.5 will be used as its value.

Case 1: Installing JReport Server 13.5 to a new folder (recommended)

1. Provided that the old JReport Server is located in `C:\JREntServer580`. Install JReport Server 13.5 to a new folder `C:\JReport\ServerV13.5`. DO NOT start the newly installed JReport Server.
2. In the DOS window, switch to `<install_root>\bin`, and run `MigrationBV52 C:\JREntServer580`.

Case 2: Installing JReport Server 13.5 to the folder where the old version resides

1. Provided that the old JReport Server is located in `C:\JREntServer580`. Install JReport Server 13.5 to the same location. DO NOT start the newly installed JReport Server.
2. In the DOS window, switch to `<install_root>\bin`, and run `MigrationBV52.bat`.

## Upgrading in an integration environment

1. Suppose that you already have a standalone JReport Server 13.5, whether it is installed directly or upgraded from a previous version. In this step you need not convert the old version reports.
2. Use the JReport Server 13.5 to create a self-contained WAR/EAR file. For information on how to create the WAR/EAR, see Building a WAR/EAR file to include a self-contained JReport Server. Remember that when building the jreport.war file in a standalone JReport Server 13.5, the ReportHome of jreport.war must be the same as that of the jreport.war in the previous version.
3. Use the Java application server that integrates the previous version of JReport Server to deploy the new self-contained WAR/EAR and update the old WAR/EAR with the new one.

   By now, if the previous version of JReport Server is later than V6.0 (included), the integrated JReport Server has already been upgraded to V13.5. But if the previous version is earlier than V6.0, go to step 4 and you need do further upgrade.

4. For a previous version between V5.2 Build 590 (included) and V6 (excluded): in the DOS window, switch to `<reporthome>\bin`, and run `MigrationV52.bat`.

   For a previous version earlier than V5.2 Build 590 (excluded): in the DOS window, switch to `<reporthome>\bin`, and run `MigrationBV52.bat`.

5. Clear the temporary files or cached files on the application server. Take Tomcat as an example, remove the temp and work directories in `D:\Tomcat`.