Upgrade Procedure (V10.0 to V11.0) on Windows

Functions

You can upgrade the Web project from version 10.0 to version 11.0 through an independent auxiliary upgrade procedure, including compatible upgrades for JAR packages, plugins, various configuration files, FineDB data tables, etc.

1.    The program of installation-free version is available.

2.    The program supports five languages: Simplified Chinese, Traditional Chinese, English, Japanese, and Korean

3.    It supports Windows and Linux.

Notes

1.    Contact sales personnel before upgrading authorized and usable 10.0 project to apply for migration authorization. After upgrading, the project needs reauthorization.

2.    Upgrade tool only supports FineReport 10.0 with JAR packages released on 2020/08/04 or later. Currently, the upgrade tool only supports upgrading project from 10.0 version to the latest 11.0.X. version.

Note: The upgrade tool is for the report project. If you have a local designer, you need to download the designer of version 11.0 by yourself and then connect to the report project remotely. For details, see Download FineReport. 

1.    Upload the upgrade tool to the server.

2.    After closing the project, start the upgrade tool as an administrator.

3.    The front desk operator panel appears. Enter the project path.

Note: You need to enter the project path to be upgraded. This is the webroot in the container such as tomcat, not in the designer directory.

4.    Click ... to select the path of the backup project. (You can skip this step.)

If you do not select backup path to upgrade directly, a prompt appears: If the backup directory is not selected, the backup will be skipped, and the upgrade will be performed directly. Confirm in advance that the original project and configuration database have been backed up, and whether you are sure to skip the backup. Click Yes to directly upgrade.

5.    Click Start upgrade, the upgrade progress appears. After successful upgrade, upgrade success appears.

6.    Close the upgrade operator panel.

7.    After successful upgrade, start Tomcat.

Use the command to switch to the tomcat/bin directory, double click startup.bat to start tomcat (just start the project according to your own startup method) and go to the decision platform. The access path is the same as one of the original 10.0 project.

Platform URL: http://IP:{port}/webroot/decision (Webroot is the project name and decision is the Servlet name.)

Template URL: http://IP:{port}/webroot/decision/view/report? viewlet=xxx.cpt or xxx.frm

After using the upgrade tool, the external database will be turned into the internal FineDB database. If you need to migrate to your own database, you need to re-migrate the relevant documents. For details, see  Configure the External Database.

Create the table based on the documentation for the corresponding database and the instructions such as the code for creating the table. Otherwise, migration fails.

Note:

1. The upgrade tool does not modify any data in the original external database but copies the data to generate a built-in database for upgrade and modification.

2. To be independent of the old-version external database and not affect the previous environment, you can create a database for migration based on the same users of the original database. After the project 11.0 can run stably, you can delete the original external database of the project 10.0. If you build the database in the preparations, simply use it.

Confirming Configuration of the External Database after Upgrading a Single Node

1.    Upgrade node one according to the section "Procedure of Upgrade Tool".

2.    After node one is upgraded, use the tablespace created in Preparation Before Upgrading FineReport 10.0 to 11.0 to migrate an external database. For details, see Configure the External Database.

Confirming Normal Configuration of the Single-Node Cluster

After external database configuration, the cluster configuration is retained by default. You can proceed to the next step after confirming node management without error messages.

Synchronizing Upgrade Files

1.    Shut down tomcat on all nodes and delete the WEB-INF folder in the webroot of the node that was not upgraded (make sure that you complete the backup before deleting).

2.    Copy the WEB-INF folder in the webroot in the upgraded node to other nodes (only after you configure the external database and open the cluster), and delete the cluster.properties file in the WEB-INF\config.

3.    Start the tomcat of each node in turn. After successful startup, you can see that the original cluster upgrades successfully.

You can roll back to the previous version If you encounter serious failures after upgrading.

1.    The upgrade tool is for the Web project only, and not for the designer. If the designer needs upgrading, you can first install project 11.0 from scratch, then upgrade the project under the old designer to project 11.0 and copy the upgraded project to the newly installed 11.0 designer directory ( to replace the webroot file in the 11.0 webapps directory with the upgraded project file).

2.    A Web project can be upgraded only once by using the upgrade tool, regardless of whether it is successful or not. You can only upgrade it again through the 10.0 project that was backed up.

3.    You cannot upgrade it across versions through the upgrade tool. For example, if you want to upgrade the project 9.0 to the project 11.0, you need to upgrade the project to the project 10.0 first, and then upgrade from the project 10.0 to the project 11.0.

4.    If tools. jar has been configured in the project 10.0, you do not need to reintroduce the tool package of tools. Instead, place tools.jar in %JAVA_HOME%/jdk/lib into either %TOMCAT_HOME%/lib and %TOMCAT_HOME%/webapps/ project name /WEB_INF/lib. If not, an error of 500 is reported during the server deployment.

5.    The upgrade tool supports following official plugins of data set.

6.    When upgrade fails, a message of failure is displayed on the foreground operation panel, indicating the specific failure cause and information.

7.    When upgrading from the project 10.0 to the project 11.0, the schedule, backup, and logs directories are skipped by default in the backup step. If the upgrade fails, you cannot use the original project again. You can copy the schedule, backup, and logs files in the original project to the backup directory and use the backup project.

8.    Comparison description of log keywords: Some keywords of the upgrade process are listed in the following table. If a module fails to be upgraded, you can search for the keyword to confirm.