How to Rollback from 6.0.5 to 5.1

In some scenarios, you may need to roll back to the previous version. This article outlines how to rollback and then upgrade.

To determine whether an external database is configured, go to Manage > System > General.

• If To be Configured is displayed, it indicates that you are currently using a built-in database.

• If Configured is displayed, it indicates that an external database is being used.

You can refer to Cluster (Using File Server) in this article to learn how to backup and restore.

Backup Before Upgrade

To roll back projects using the built-in database to a previous version, you need to back up the following data before initiating the upgrade process.

Close the FineBI project. Copy the webroot folder under %FineBI%\webapps\webroot (the backup webroot folder cannot reside within the FineBI installation path).

Note: If the webroot folder is large (over 4 GB), backing up the entire folder may take too long. In this case, back up only the WEB-INF folder in webroot. If WEB-INF is also very large (over 2 GB), backing it up may still take a long time. As an alternative, back up only the dashboards, embed, lib, plugins, and reportlets folders in WEB-INF.

Rollback Steps

1. Close the BI server.

2. Replace projects.

If you are using the built-in database before upgrading, back up the old project's webroot file, and replace the webroot file under %FineBI%\webapps with it.

Note: If only WEB-INF was backed up, restore the WEB-INF backup. If only the dashboards embed, lib, plugins, and reportlets folders under WEB-INF were backed up, restore those corresponding folders.

3. Restart the BI server.

Upgrade

Method One (Recommended)

Backup Before Upgrade

To use method one, follow the steps below.

1. Close the FineBI project. Copy the webroot folder under %FineBI%\webapps\webroot (the backup webroot folder cannot reside within the FineBI installation path).

Note: If the webroot folder is large (over 4 GB), backing up the entire folder may take too long. In this case, back up only the WEB-INF folder in webroot. If WEB-INF is also very large (over 2 GB), backing it up may still take a long time. As an alternative, back up only the dashboards, embed, lib, plugins, and reportlets folders within WEB-INF.

2. Manually back up the external database. The backup database password must match the original database password.

Rollback Steps

1. Close the BI server.

2. Replace projects.

Back up the old project's webroot file, and replace the webroot file under %FineBI%\webapps with it.

Note: If only WEB-INF was backed up, restore the backup WEB-INF. If only the dashboards, embed, lib, plugins, and reportlets folders under WEB-INF were backed up, restore those corresponding folders.

3. Restore external database

If a new database is created for the external database backup, with a different database name, username, password, etc. from the original database, modify db.properties under %FineBI%/webapps/webroot/WEB-INF/config. Update the file based on the connection information of the backup database.

If the database name, username, password, etc. of the backup database are the same as the previous database, there is no need to modify other settings.

4. Start FineBI to complete the rollback.

Method Two

Backup Before Upgrade

If you need to use method two, follow the steps below.

Go to Manage>Intelligent Operations>Backup and Restore, and click Manual Backup under Platform Configuration, Report Templates, JAR Packages, and Plugin respectively.

Rollback Steps

1. Close the FineBI project.

2. Restore report templates.

Delete the reportlets folder in %FineBI%/webapps/webroot/WEB-INF. In %FineBI%/webapps/webroot/backup/reportlets/manual, locate the backup folder based on the folder name (backup time). Copy the reportlets folder from the backup folder to %FineBI%/webapps/webroot/WEB-INF.

3. Restore JAR packages.

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

In %FineBI%/webapps/webroot/backup/jar/manual, locate the backup folder based on the folder name (backup time). Copy the lib folder from the backup folder to %FineBI%/webapps/webroot/WEB-INF.

4. Restore plugins.

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

In %FineBI%/webapps/webroot/backup/plugins/manual, locate the backup folder based on the folder name (backup time). Copy the plugins folder from the backup folder to %FineBI%/webapps/webroot/WEB-INF.

5. Restore the external database.

In %FineBI%/webapps/webroot/backup/config/manual, locate the backup folder based on the folder name (backup time). Unzip the config.zip file in the backup folder to obtain finedband replace the finedb file in %FineBI%/webapps/webroot/WEB-INF/embed with it.

Delete the db.properties file in %FineBI%/webapps/webroot/WEB-INF/config. After you delete this file, the project will read the content in finedb when it starts.

6. Start the project to complete the rollback. You can then reconfigure the external database as needed.

Upgrade

Method One (Recommended)

Backup

1. Close all nodes in the project.

2. Back up the webroot folders of each node.

Note: If the webroot folder is large (over 4 GB), backing it up may take a long time. In this case, back up only the WEB-INF folder in webroot. If WEB-INF is also very large (over 2 GB), backing it up may still take a long time. As an alternative, back up only the lib and plugins folders in WEB-INF.

3. Back up the WEB-INF folder on the file server.

Note: If WEB-INF is large (over 2 GB), backing it up may take a long time. As an alternative, back up only the dashboards and reportlets folders in WEB-INF.

4. Back up the external database on the database server. The password of the backup database should be the same as the previous external database.

Restore

1. Restore the webroot folders from the previous backup at each node.

Note: If only the WEB-INF folder is backed up, then restore the backup WEB-INF; if only the lib and plugins folders in WEB-INF are backed up, then restore the corresponding folders.

2. Restore the WEB-INF folder on the file server.

If only the dashboards and reportlets folder in WEB-INF have been backed up, then restore the corresponding folders.

3. Restore the external database.

If the database name, username, etc. of the restored database differ from the original one, you need to modify the following configurations when restoring:

Modify the db.properties file in %FineBI%/webapps/webroot/WEB-INF/config on each node of the cluster based on the connection information of the backup database.

If the database name, username, password, etc. of the restored database are the same as the previous database, there is no need to modify the configuration of db.properties.

5. Start each node of the cluster in sequence.

Method Two

Backup

Go to Manage>Intelligent Operations>Backup and Restore, and click Manual Backup under Platform Configuration, Report Templates, JAR Packages, and Plugin respectively.

Restore

Backup can be found on the file server in the backup folder located in the same directory level as the WEB-INF folder.

1. Restore report templates.

Delete the reportlets folder in WEB-INF of the file server.

In backup/reportlets/manual on the file server, locate the backup folder based on the folder name (backup time). Copy the reportlets folder from the backup folder to WEB-INF of the file server.

2. Restore JAR packages.

Delete the lib folder in the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

In the backup/jar/manual directory, locate the backup content based on the folder name (backup time). Copy the lib folder to the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

3. Restore plugins.

Delete the plugins folder on each node of the cluster.

In the backup/plugins/manual directory on the file server, locate the backup folder based on the folder name (backup time). Copy the plugins folder to the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

4. Restore the external database.

In the backup/plugins/manual directory on the server, locate the backup folder based on the folder name (backup time). Unzip the config.zip file in the backup folder to obtain finedb. Replace the finedb file in %FineBI%/webapps/webroot/WEB-INF/embed on one node of the cluster.

Delete the db.properties file located in the %FineBI%/webapps/webroot/WEB-INF/config directory on this node of the cluster. (After this file is deleted, the project will start reading the content in finedb).

5. Start this node of the cluster.

6. After successful startup, configure the external database.

7. Copy the db.properties file located in the %FineBI%/webapps/webroot/WEB-INF/config directory on this node to the %FineBI%/webapps/webroot/WEB-INF/config directory on the other nodes of the cluster.

8. Start other nodes.

For details, see Upgrade Cluster to Version 6.0

Method One (Recommended)

Backup

1. Shut down all nodes in the project.

2. Back up the webroot folders of each node.

Note: If the webroot folder is large (over 4 GB), backing it up may take a long time. In this case, back up only the WEB-INF folder in webroot. If WEB-INF is also very large (over 2 GB), backing it up may still take a long time. As an alternative, back up only the dashboards, lib, plugins, and reportlets folders in WEB-INF.

3. Back up the external database on the database server. The password of the backup database should be the same as the previous external database.

Restore

1. Restore the previously backup webroot on each node in the cluster.

Note: If only WEB-INF was backed up, the system will restore the WEB-INF backup. If only the dashboards, lib, plugins, and reportlets folders in WEB-INF were backed up, then the corresponding folders will be restored.

2. Restore an external database.

If the database name, username, etc. of the backup database differ from the original one, you will need to modify the following configurations when restoring:

Modify db.properties in %FineBI%/webapps/webroot/WEB-INF/config of each node in the cluster based on the connection information of the backup database.

If the database name, username, password, and other information of the backup database are the same as the previous database, then the configuration of db.properties does not need to be modified.

3. Start each node in the cluster in sequence.

Method Two

Backup

Go to Manage>Intelligent Operations>Backup and Restore, and click Manual Backup under Platform Configuration, Report Templates, JAR Packages, and Plugin respectively.

Restore

The backup content is located under %FineBI%/webapps/webroot/backup on the master node of the cluster.

1. Restore report templates.

Delete the reportlets folder under the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

In the %FineBI%/webapps/webroot/backup/reportlets/manual folder, find the backup content based on the folder name (backup time), and copy the reportlets folder to the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

2. Restore jar packages.

Delete the lib folder under the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

In the %FineBI%/webapps/webroot/backup/jar/manual folder, find the backup content based on the folder name (backup time), and copy the lib folder to the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

3. Restore plugins.

Delete the plugins folder under the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

In the %FineBI%/webapps/webroot/backup/plugins/manual folder, find the backup content based on the folder name (backup time) and copy the plugins folder to the %FineBI%/webapps/webroot/WEB-INF directory on each node of the cluster.

4. Restore the external database.

In the %FineBI%/webapps/webroot/backup/config/manual folder, find the backup content based on the folder name (backup time), and replace the finedb file under %FineBI%/webapps/webroot/WEB-INF/embed with the finedb file obtained by decompressing the config.zip backup.

Delete the db.properties file under %FineBI%/webapps/webroot/WEB-INF/config. After you delete this file, the project will read the content of the internal finedb upon startup.

5. Start this node of the cluster.

6. After successful startup, configure the external database.

7. Copy the db.properties file under %FineBI%/webapps/webroot/WEB-INF/config on this node to the %FineBI%/webapps/webroot/WEB-INF/config directory on the other nodes of the cluster.

8. Start other nodes.

Upgrade

For details, see Upgrade Cluster to Version 6.0.

Update

Because after the upgrade, all self-service datasets that have been set to update with the parent report will be updated again. Therefore, the db file structure of the self-service dataset will change. If you roll back to version 5.1, some self-service datasets may fail to preview due to changes in the updated db file structure and need to be updated again to be displayed correctly.

If there are too many tables that need to be updated and it is not convenient to perform a global update, you can set the following parameters:

• Table: fine_conf_entity

• id: DistributedOptimizationConfig.spiderConfig.spider_ignore_base_update

• value: true

Once the parameters have been set, you need to restart the project in order for the changes to take effect.

Once the parameters have been set, the global update will skip the update for base tables and only update the self-service datasets.

Plugin

If you are attempting to upgrade to version 6.0 from version 5.1.18 or an earlier version, pay attention to the following notice.

The FineBI plugin store resources differ between versions before 5.1.18 (FR10) and 5.1.18 and above (FR11).

When you upgrade the FineBI plugin store version from FR10 to FR11, the upgrade process will automatically switch to using the FR11 plugin store resources. If you want to use plugins of previous versions, you need to manually switch the plugin store back to using the FR10 resources.