Project Backup and Restoration

Version

Application Scenario

The project backup can protect data, ensure business continuity, and provide flexibility.

1. Data protection: The admin can restore lost or damaged business data through backups, ensuring data integrity and availability.

2. Business continuity: The admin can restore the project to its previous state through backups in the event of a catastrophic event to continue business operations, reducing downtime and data loss.

3. Version control and rollback: The admin can create project snapshots at different time points through backups to record the status and changes of the project, making it easier to control versions, roll back to old versions, and find problems.

4. Environment migration and deployment: The project backup can help you migrate and deploy programs in different environments. You can restore the complete structures and configurations of the programs in a new environment through backups, simplifying the migration process and reducing errors.

5. Security and compliance: The admin can restore the project to the previously secure status through backups, protecting data confidentiality and integrity to comply with regulations and security standards.

In summary, the project backup is a critical step in ensuring data security and business continuity and flexibility. Whenever you encounter unexpected events, requirement changes, or catastrophic restoration events, the backup is a reliable means of protecting and restoring projects.

Function Description

This document mainly introduces the backup solution for the project deployed through the common method.

The critical business in the project is automatically backed up at fixed intervals to prevent unexpected incidents and facilitate the restoration.

Backup Method

Backup content: You can back up templates, plugins, JAR packages, and platform configurations in the project.

Backup frequency: You are advised to perform backups once a week and retain the latest five backups.

Backup operation: Log in to the FineBI system as the admin, choose System Management > Intelligent O&M > Backup & Restoration and click Global Setting to enable the automatic backup.

Storage location: The backup content is stored in the path %BI_HOME%\webapps\webroot\backup of the project.

Restoration Method

Log in to the FineBI system as the admin, choose System Management > Intelligent O&M > Backup & Restoration and respectively restore the automatic backups with the same time in Platform Configuration, Report Template, JAR Package, and Plugin.

Since mutual impacts exist in the above four options, that is, plugins match jar packages, templates match platform directories, and template functions are associated with JAR package functions, you need to restore all backups generated for the four options at the same time. You cannot only restore the backup of one option or restore backups from different time points.

Before the migration or upgrade, you can manually perform offsite backups for the overall project to facilitate the quick rollback in case of the migration/upgrade failure.

Backup Method

1. Server for the Backup

You are advised to prepare an additional server for storing project backup files. If the backup is performed on the local machine, the security of the backup files cannot be guaranteed in case of unexpected server issues.

2. Check of finedb Configuration Base Information

Log in to the project as the admin, choose System Management > System Setting > General, and check whether the external database has been configured.

• Configured: The external database has been configured in the project. You can click the button to record the configuration base location of the project.

• To Be Configured: The external database is not configured in the project. The internal database is used.

3. Project Node Closing

Disable the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project.

4. Project Path Check

The project is usually stored in the path %Tomcat_HOME%/webapps/webroot. However, if the external directory is configured for short links, the path will change.

Check whether docBase is configured in the path %Tomcat_HOME%/conf/server.xml. If so, the path is the same as that of the external directory in the project.

5. Project File Backup

Back up the webroot folder in the confirmed path in the last section to the server prepared in the first section.

If the cluster file server is configured, you need to back up the folder separately and completely.

If server resources are insufficient and the size of the webroot folder is too large, the files in the project and the file server should be backed up, as shown in the following table.

6. External Database Backup

If the project (checked in the second step) has been configured with an external database, you need to back up the database separately.

Back up the database through a third-party tool and upload the backup file to the server prepared in the first step.

7. Project Node Re-startup

By now, you have completed the project backup. Restart the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project. After startup, the project can run normally.

Restoration Method

1. Project Node Closing

Disable the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project.

2. External Database Restoration

Restore the backed-up external database to the target database.

3. Project File Restoration

Copy and paste the backed-up project files to the project directory or the external directory.

Note:

For a cluster project, you need to copy and paste the files to each project node server.

4. Project Node Re-startup

Restart the standalone project node or each project node in the cluster by referring to Closing or Restarting the FineBI Project. After startup, the project can run normally.