Rollback to the original version after a cross-version upgrade

In some cases, users may need to revert to the pre-upgrade version.

The documentation provides the steps to roll back to the original version after the upgrade.

Go to "Management  > System  > General" to see whether an external database is used, as shown in the following figure:

• If "To be configured" is displayed: the database type is the built-in database.

• If "configured" is displayed: the database type is an external database.

2.1 Cluster related

If the user configures a cluster, the "file server" needs to be backed up. For details, please refer to: File Server Section 3.3

Reconfigure the cluster after the rollback.

3.1 Backup before upgrade

Rolling back a project using the built-in database requires the user to perform the following backups before upgrading:

Close the FineBI project and copy the webroot folder in the path %FineBI%\webapps\webroot (the backup webroot file cannot be placed in the FineBI installation path)

Note: If the webroot is relatively large (more than 4G), the backup will take too long, you can only backup the WEB-INF folder under the webroot; if the WEB-INF is also very large (more than 2G), the backup will still take a long time. You can only backup the dashboards, embed, lib, plugins, reportlets, resources folders under WEB-INF.

3.2 Fallback steps

1) Shut down the BI server

2) Replacement project

If you are using a built-in database before the upgrade, replace the old project webroot file with the backed up webroot file in the %FineBI%\webapps path, as shown in the following figure:

Note: If only WEB-INF is backed up, restore the backed up WEB-INF and start the project; if only the dashboards, embed, lib, plugins, and reportlets folders under WEB-INF are backed up, then restore the corresponding folders.

3) Restart the BI server.

4.1 Method 1 (recommended)

4.1.1 Backup before upgrade

Method 1 requires the user to perform the following backups before upgrading:

1) Close the FineBI project and copy the webroot folder under the path %FineBI%\webapps\webroot (the backup webroot file cannot be placed in the FineBI installation path)

Note: If the webroot is relatively large (more than 4G), the backup will take too long, you can only backup the WEB-INF folder under the webroot; if the WEB-INF is also very large (more than 2G), the backup will still take a long time. You can only backup the dashboards, embed, lib, plugins, reportlets folders under WEB-INF.

2) Manually back up the external database. The password of the backup database needs to be the same as that of the previous database.

4.1.2 Fallback steps

1) Shut down the BI server.

2) Replacement project

Replace the backed up old project webroot file with the webroot file in the %FineBI%\webapps path, as shown in the following figure:

Note: If only WEB-INF is backed up, restore the backed up WEB-INF; if only the dashboards, embed, lib, plugins, and reportlets folders under WEB-INF are backed up, then restore the corresponding folders.

3) Restore the external database

If a new external database to be backed up is created, and the database name, user name, and password to be backed up are different from the original database name, modify db.properties in the %FineBI%/webapps/webroot/WEB-INF/config directory.Modify the file based on the connection information of the backup database，as shown in the following figure:

If the database name, user name, password, etc. of the backup and restored database are the same as those of the previous database, you do not need to modify other configurations.

4) Start FineBI to complete the rollback.

4.2 Method 2

4.2.1 Backup before upgrade

Go to "Management  > Intelligent Operation > Backup and Restore", and perform "manual backup" of "Platform Configuration, Report Template, BI Template, Jar Package, Plugin", as shown in the following figure:

Note: FineBI released before 2020.01.15 cannot successfully backup DingTalk configuration.

4.2.2 Fallback steps

1) Close the FineBI project.

2) Restore the report template.

Delete the reportlets folder in the %FineBI %/webapps/webroot/WEB-INF directory; under %FineBI%/webapps/webroot/backup/reportlets/manual , find the backup content according to the folder name (backup time) , and copy the reportlets folder to the %FineBI%/webapps/webroot/WEB-INF directory.

3) Restore the BI template.

Delete the dashboards folder in the %FineBI %/webapps/webroot/WEB-INF directory; under%FineBI%/webapps/webroot/backup/dashboards/manual , find the backup content according to the folder name (backup time) , copy the dashboards folder to the %FineBI%/webapps/webroot/WEB-INF directory;

4) Restore the jar package.

Delete the lib folder in the %FineBI%/webapps/webroot/WEB-INF directory;

Under %FineBI%/webapps/webroot/backup/jar/manual , according to the name of the folder (backup time), find the contents of the backup, and copy the lib folder to the %FineBI%/webapps/webroot/WEB-INF directory ;

5) Restore the plugin.

Delete the plugins folder in the %FineBI%/webapps/webroot/WEB-INF directory;

Under %FineBI%/webapps/webroot/backup/plugins/manual , according to the name of the folder (backup time), find the backup content, and copy the plugins folder to the %FineBI%/webapps/webroot/WEB-INF directory ;

6) Restore the external database.

Under %FineBI%/webapps/webroot/backup/config/manual , according to the name of the folder (backup time), find the contents of the backup, extract the finedb obtained by decompressing the backup config.zip, and replace %FineBI%/webapps/webroot The finedb file under /WEB-INF/embed , as shown in the following figure:

Delete the db.properties file under %FineBI%/webapps/webroot/WEB-INF/config ; after this file is deleted, the project starts to read the content of the built-in finedb.

7) Start the project and complete the rollback. Users can reconfigure the external database as needed.

5.1 Backup before upgrade

Users are required to make the following backups before upgrading:

1) Close the FineBI project, copy the webroot folder in the path %FineBI%\webapps\webroot (the backup webroot file cannot be placed in the FineBI installation path), and if there are several nodes, back up several webroot projects.

2) Manually back up the external database. The password of the backup database needs to be the same as that of the previous database.

5.2 Fallback steps

1) Shut down the BI server.

2) Replacement project

Replace the backed up old project webroot file with the webroot file in the %FineBI%\webapps path, and replace several webroot projects with several nodes, as shown in the following figure:

3) Restore the external database

• If the external database is backed up for a new database, that is, the database name, user name, password, etc. of the backup and restoration are inconsistent with the previous database name, then for one of the nodes, modify the node %FineBI%/webapps/webroot/WEB-INF/config db.properties under the path, modify the file according to the connection information of the backup database, as shown in the following figure:

After the above node restores the external database, copy the db.properties file under %FineBI%/webapps/webroot/WEB-INF/config to the config file of other nodes, and ensure that the same external database is used.

• If the rollback is still performed in the previous database, that is, the database name, user name, password, etc. of the backup and restoration are consistent with the previous database name, there is no need to modify db.properties.

4) Start FineBI to complete the rollback.