I. Overview
The Backup and Restore feature serves to backup and restore files related to Platform Configuration (FineDB and resources), Report Template, Jar Package and Plugin, as well as Version Update and Upgrade.
Note:
the deployment of wrapped WAR file doesn't support backup and restore feature, but it is available for unwrapped WAR file deployment
WAR file deployment on WebLogic server is set to wrapped deployment by default, while WAR file deployment on WebSphere or Tomcat is considered as unwrapped deployment. You can check the system deployment type on the decision-making platform. In the case of unwrapped deployment, the WAR file is automatically unwrapped to support the backup and restore feature.
| You will learn |
|---|
|
II. Resource Backup and Restore
For version before 10.0.11, if the platform database is built-in database, resource backup and restore (Platform Configuration (FineDB and resources), Report Template, Jar Package and Plugin) will not be supported. Please configure external database.
1. Go to Backup and Restore
1) Login to the platform via Server -> Platform Management Login to the decision-making platform as the super administrator.
2) Click on Manage -> Intelligent Operation -> Backup and Restore to enter the interface.
2. Global Setting
Click to configure global settings of resource backup and restore.
Note: Platform Configuration, Report Template, Jar Package and Plugin are included in the backup scopes with the same approach. This article takes the backup of Platform Configuration as an example to demonstrate the necessary steps.
1) Backup Path: the path is set to the same level as the %FR_HOME%/webapps/webroot/backup directory by default. You can also change the directory to another path within the current webroot.
2) Auto Backup
| Item | Description | Note |
|---|---|---|
| Backup Frequency | every day, every week, every month, every 3 months and every 6 months are provided as options, with every week as its default value. | - |
| Number of Copies | it is set to 5 paths by default. When the number of copies reaches the maximum limit, the oldest auto backup will be deleted to generate a new one. | Will take effect next time when backup is triggered. |
| Backup Capacity | the default value is set to 1024M. When the disk space reaches its limit, the oldest auto backup will be deleted to generate a new one. | Will take effect next time when backup is triggered. |
3) Backup failure notice: when the backup fails, message can be sent through [Platform notification], [SMS], or [Email]. Please refer to how to enable SMS and Email service.
Note: only versions after 10.0.11 will support backup failure notice.
3. Manual Backup
Click on Manual Backup to open the dialog, where you can enter custom names, then click OK to complete the manual backup.
4. Auto Backup
Auto Backup is set in the global settings, including Backup Frequency, Number of Copies and Backup Capacity.
Please refer to II-2 section.
5. Restore
1) Precautions
For Finereport projects of 10.0.14 and later versions, after restoring a backup of a certain version, the restored version will not be automatically deleted, and the current version will be automatically backed up.
For example, the plugin was backed up once at the 1st zero o'clock, and backup A was generated.
When the next day zero o'clock restores backup A, the plugin used in the next day zero o'clock project will be automatically backed up to generate backup B. And after the restore operation is complete, backup A still exists.
For the version of Finereport project before 10.0.14, after restoring a backup of a certain version, the restored version will be automatically deleted, and the current version will be automatically backed up.
For example, the plugin was backed up once at the 1st zero o'clock, and backup A was generated.
When the next day zero o'clock restores backup A, the plugin used in the next day zero o'clock project will be automatically backed up to generate backup B. But after the restore operation is completed, backup A will be automatically deleted.
2) Restore method
Locate the backup file under Manual Backup or Auto Backup list and click on the Restore button. A pop-up window indicating "Restore completed, please restart" will be presented once the restore is completed. Restart the server to complete the process.
Note:
the current version is automatically backed up once restores. The backup of target version will be deleted.
when restarting the server, please ensure that the server is shut down properly and avoid abrupt shutoff (such as to simply quit the operation window of the Tomcat server).
For different resource, time of taking effect will be different:
| Resource | Time of taking effect |
|---|---|
| Platform Configuration | Take effect after restarting the server. |
| Report Template | Take effect immediately:
|
| Jar Package | Take effect after restarting the server. |
| Plugin | Take effect immediately. |
6. Delete the Previous Backup
Check the backup files to be deleted. Click on Delete to proceed with the deletion. The process for Auto Backup is the same.
The backup files are stored in %FR_HOME%\webapps\webroot\backup
| Folder Name | Resource |
|---|---|
config | Platform configuration |
jar | JAR package |
plugins | Plugin |
reportlets | Report Template |
For example, the backup files of Platform Configuration are located in folder "manual" and "auto" under %FR_HOME%/backup/config.
The folder "manual" contains files that are manually backed up.
The folder "auto" contains files that are automatically backed up.
III. Version Update
In the Update and Upgrade tab, you may click [update now] to update the jar version (if there is any new release).
History version will be shown below in the [Jar Package Restore], you may choose one to restore.
