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

Functions

You can upgrade the 10.0 web project to the 11.0 project through an independent auxiliary upgrade procedure, including compatible upgrades for JAR packages, plug-ins, 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 operating systems.

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. The prerequisite of upgrading FineReport 10.0 by the upgrade tool is to have the JAR package with a date of 2020/08/04 and 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.     Use the upload tool to upload the upgrade tool to the server and select a directory to place the upgrade tool (do not put it under Tomcat).

2.     Stop Tomcat: 

a.    ps -ef | grep tomcat       #Check Tomcat's process pid number

b.    kill -9 pid             #Close the Tomcat process (pid is the process number just found)

c.     ps - ef | grep tomcat    #to see if there are any residual processes, and kill it if so

3.     Switch the directory to the upgrade tool directory.

Note: FineUpgrade_v11_linux_xxx.sh stands for the name of the upgrade tool. The tool name in the following code is an example. You can modify it according to the actual situation.

4.     Empower the upgrade tool chmod +x FineUpgrade_v11_linux_2022-09-30-amd64-CN.sh.

5.     Launch the upgrade tool./FineUpgrade_v11_linux_2022-09-30-amd64-CN.sh.

6.     Enter the project path, and you can prepare the path in advance, example: /opt/tomcat11/webapps/webroot

7.     Choose whether to skip the backup according to the prompt. Enter N and the prompt appears: Please choose backup path. Enter the backup path and start upgrade.

Enter Y to skip the backup and enter Y again to start upgrade.

8.     Upgrade success appears after the upgrade is successful.

9.     Start Tomcat after the upgrade is successful, switch the tomcat/bin directory through the command, execute ./startup.sh, and access the decision-making platform after successful start, which is consistent with the original 10.0 access path.

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

The process is as follows:

Choose whether to skip the backup according to the prompt. Enter N and the prompt appears: Please choose backup path, enter the backup path and upgrade begins;

Enter Y and press enter, a message appears: If you do not select the backup directory, you will skip the backup and directly upgrade. Please confirm that you have backed up the original project and configuration database in advance, and whether you are sure to skip the backup. Enter Y again and upgrade begins, as shown in the following figure:

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, 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 external database of the project 10.0 and not affect the previous environment, you can create a database for migration. After the project 11.0 can run stably, you can delete the original external database of the project 10.0.

Cluster Upgrade

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.    Close Tomcat on all nodes and delete the WEB-INF folder under webroot on the node that has not been upgraded (ensure that you have backed up files before deleting). Otherwise, subsequent copying files causes files of version 10.0 to still exist and errors occur when starting up.

2.    Copy the WEB-INF folder in the webroot on the upgraded node to other nodes (only after you configure the external database and start the cluster), and delete the cluster.properties file in the WEB-INF\config. Start Tomcat on each node in turn and  cluster deployment succeeds.

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 is displayed, indicating the specific failure cause and information. You can run lsof -i:20216 and lsof -i:20217 to look for pid. If you find pid, kill it and upgrade it again.

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.