Backup and Restoration

For FanRuan projects deployed in FineOps, the Backup & Restoration function is provided in Intelligent Q&M. One-click backup, automatic backup, and off-site backup are supported.

The backup and restoration function introduced in this document is not suitable for FanRuan projects deployed in FineOps.

You are advised to back up and restore projects in FineOps. One-click backup, automatic backup, and off-site backup are supported. One-click restoration and downtime restoration are supported.

Version

Application Scenario

Only the latest version of a plugin can be found in Plugin Management when you need its old versions.

You deleted important report templates or dashboards accidentally.

You want to roll back after the JAR package update.

Function Description

You can back up and restore Platform Configuration, Report Template, JAR Package, and Plugin.

Unsupported Scenario

Projects deployed with compressed WAR packages do not support backup and restoration, while those deployed with uncompressed WAR packages can be backed up and restored.

By default, WAR package deployment in WebLogic Server is a compression deployment. In WebSphere and Tomcat, WAR package deployment is a non-compression deployment.

Backup Path Setting

Note:

Only the super admin can set the backup path.

Log in to the FineBI system as the super admin, choose System Management > Intelligent O&M > Backup & Restoration, and click the global setting icon to set the backup path, as shown in the following figure.

The default backup path is .../backup. The backup file is stored under the path %FineBI%/webapps/webroot/backup.

You can modify the backup folder to another folder but cannot store the backup file under non-project paths.

If you remove the characters (../) at the beginning when modifying the backup storage path, the backup file will be stored under the path %FR_HOME%/webapps/webroot/WEB-INF of the project.

Backup Methods

Platform Configuration, Report Template, JAR Package, and Plugin tab pages support the two methods: Manual Backup and Auto Backup.

Manual Backup

Click Manual Backup, customize the backup name in the pop-up dialog box, and click OK to finish the manual backup.

Auto Backup

The super admin can set Backup Frequency, Maximum Records, Backup Capacity, and Backup Failure Reminder under Global Setting > Auto Backup.

The following table describes the setting items.

Backup File

The backup files are stored by default under the path %FineBI%\webapps\webroot\backup, as shown in the following table.

Note:

1. The super admin can modify the storage location of backup files. For details, see section "Backup Path Setting".

2. To enhance security, the names of auto-backup files are appended with random characters (not garbled code).

Take platform configuration backup as an example. The backup files are stored under the path %FineBI%\webapps\webroot\backup\config, in which the folder name is consistent with the backup method. (The manual folder stores manual-backup files while the auto folder stores auto-backup files.)

Backup Management

You can rename and delete the backup. The renaming and deletion procedures are the same between Manual Backup and Auto Backup.

1. Renaming

Select the to-be-renamed backup, click the renaming button, enter the new name, and click OK.

2. Deletion

Select the to-be-deleted backup, click the deletion button, and click OK.

Notes

Problem

The backup fails with an error "java.sql.SQLDataException: data exception: string data, right truncation; table: FINE_CONF_ENTITY column: VALUE" is displayed.

Cause:

There exists excessively long data in the fine_conf_entity table, causing backup failure.

Solution:

1. Filter out and delete excessively long data fields.

2. (This solution can only be used in external databases like MySQL.)

The super admin can adjust the maximum length limit by modifying the value of the parameter BackupConfig.customValueLength through the Fine_Conf_Entity Visual Configuration plugin. The setting takes effect after you restart the server.

Notes

Auto deletion of the Restored Version

The backup for one version to be restored can still be retained after restoration. At the same time, the system automatically backs up the current version.

For example, you back up a plugin at 0:00 AM on August 1st, with Backup A being generated.

If you restore Backup A at 0:00 AM the next day, the system automatically backs up the plugin used at this time, with Backup B being generated. After restoration, Backup A is still retained.

If the to-be-restored content is important, backup corresponding files again before the restoration in section "Backup File." You can also contact our technical support for help in restoration.

Unsupported Restoration in Certain Conditions

During the restoration, some JAR packages cannot be restored to certain versions in Platform Configuration. The following table shows detailed information.

Immediate Execution of Scheduled Task Restoration

Restoration may influence scheduled tasks and scheduled backups.

After the restoration, the project may compare the current system time and determine that the scheduled task is not executed. As a result, the scheduled task is executed immediately after the restoration.

Restoration Method

Select the backup file in Manual Backup/Auto Backup, click the restoration button, and click OK to restore the backup file.

Different restoration contents take effect in different ways, as shown in the following table.

Note:

Ensure that the server is closed normally when restarting the server. Do not forcefully close the server, for example, directly closing the running window in the Tomcat server.