Project Migration

  • Last update:  2024-05-13
  • Overview

    Version

    FineBI Version
    Functional Change

    6.0

    -

    Application Scenario

    An enterprise may need to migrate the deployed project due to server expiration, copying between test and production environments, and other factors.

    Solution Selection

    FineBI provides various project migration solutions for different scenarios.

    This document describes a solution to help you migrate an existing non-containerized single-machine project to a non-containerized single-machine project.

    iconNote:
    Before viewing this solution, it is recommended to refer to the following table to select a more suitable migration solution.

    If you do not need to change the deployment method of the project, there is no need to refer to the table following. Just refer to this document for migration.

    Existing Project
    Migrated ProjectSolution Description
    Principle: You should always take clusters and containerized deployment as priorities.

    Advantages of clusters: Compared to single-machine projects, clusters have high availability, high performance, scalability, ease of management, and security assurance, making them suitable for enterprise-level report generation and management requirements.

    Advantages of containerized deployment: Compared to traditional deployment structure, containerized deployment has advantages such as isolation, portability, flexibility, scalability, and controllability, which can significantly reduce enterprise maintenance costs and resource costs.

    Single-machine project

    Uncontainerized deployment

    Containerized cluster

    Server resources are sufficient.

    The recommended configuration nodes for the project are 2 or more.

    Containerized single machine

    Server resources are tight.

    Non-containerized single machine

    You can refer to this document to finish the project migration traditionally.

    Perform containerized deployment.

    Containerized cluster

    Server resources are sufficient.

    The recommended configuration nodes for the project are 2 or more.

    Containerized single machine

    Server resources are tight.

    Cluster project

    Uncontainerized deployment

    Containerized cluster (migrates project and cluster components)

    1. Server resources are sufficient.

    2. The original cluster project can still be started after migration.

    3. New cluster projects and cluster components are deployed.

    Containerized cluster (only migrates project)

    1. Server resources are tight.

    2. After migration, only the new cluster project needs to be started, and the original project cannot be started.

    3. New cluster projects are deployed and original cluster components are called.

    Perform containerized deployment.

    Containerized cluster

    There is no other choices.

    New Project Preparation

    Deploying a New Project

    Deploy a new FineBI project. For details, see Tomcat Package Deployment in Linux.

    Confirm the Remaining Disk Space

    1. Check the size of the original project.

    2. According to the size of the original project, it is recommended to moderately expand the remaining disk space on the server node where the new project is located. (It is recommended to be larger than twice the size of the original project.

    Confirming the New Project Version

    The deployment package downloaded from the official website is usually the latest version released by FanRuan. Therefore, you need to confirm the new project version to ensure that the old project can be upgraded to the same version.

    Log in to the new project as the admin, choose System Management > Registration Management > Version Information, and confirm the minor version of the new project (accurate to the JAR package date).

    Closing the Project

    Close the new project. For details, see Closing or Restarting the FineBI Project.

    Original Project Preparation

    Backing up the Original Project

    Before project migration, you must back up the original project and then proceed with subsequent operations. This can avoid the inability to roll back caused by project file loss if the upgrade fails. For details, see Project Backup and Restoration.

    Upgrading the Original Project

    The newly deployed FineBI project is usually a newer version released by FanRuan.

    Therefore, you need to upgrade the original project to the same new version to perform migration between projects of the same version.

    1. Determining the Upgrade Necessity

    Log in to the old project as the admin, choose System Management > Registration Management > VersionInformation, and check the minor version of the old project to see if it matches the version of the new project in section "Confirming the New Project Version."

    If they are consistent, you can skip this section. Otherwise, you must perform operations in this section to upgrade the old project to the same version of the new one.

    2. Obtaining the JAR Package

    You can contact our technical support to obtain the project JAR package for the same minor version (accurate to the JAR package date) of the new project in section "Confirming the New Project Version."

    3. Upgrading the Original Project

    Upgrade the project to the specified version. For details, see How to Upgrade FineBI Between Minor Versions.

    Confirming the Original Project Configuration Database

    To ensure that the platform configuration of the old and new projects is completely consistent, it is necessary to synchronize the configuration databases of the two projects. You need to first confirm the finedb database information used in the old project.

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

    Configured: Click Configured to record the external database location information of this project. You have to ensure that the server where the new project is located is connected to the server where the external database is located.

    To Be Configured: It indicates that the project is not configured with an external database. For formal projects, the administrator is advised to configure external databases to enforce the stability when the projects are used.

    Closing the Project

    Close the original project. For details, see Closing or Restarting the FineBI Project.

    Checking the Original Project Path

    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.

    Inspection method: Check the original project file %Tomcat_HOME%/conf/server.xml to see if docBase is configured. If so, the path is the path to the external directory of the original project.

    Project Migration

    Copying and Pasting Files

    Copy and paste the contents of the webroot folder in the original path to the path %Tomcat_HOME%/webapps/webroot in the new project.

    1. Check in advance whether the original project has been configured with an external directory according to section "Checking the Original Project Path" to ensure the correct file is copied and pasted.

    2. Use the final file of the project for the copying operation instead of the file backed up in section "Backing up the Original Project."

    3. If the server resources are insufficient and the webroot folder is too large, copy the following files from the project at least.

    Project File
    Description

    /webroot/backup

    Function: It stores historical backup files of the project.

    Necessity in copying and pasting: It is up to you. If you copy and paste them, you can back them up in the original directory.

    /webroot/bi-data

    Function: It stores extracted data in FineBI.

    Necessity in copying and pasting:

    Not necessary: If the old and new projects are on the same server, you can remount the bi-data folder of the original project with -v or extract the data again after starting the new project.

    Not recommended: If the old and new projects are on different servers, you are not advised to copy and paste the file. This folder generally contains a large amount of data, making it difficult to copy and paste it. You can extract the data again after starting the new project.

    /webroot/help

    Function: It stores the custom content of the project.

    Necessity in copying and pasting: necessary

    The folder contains custom maps, custom functions, customized CSS, customized JS, and other files. Not copying them will cause abnormal template previews.

    /webroot/logs

    Function: It stores swift logs.

    Necessity in copying and pasting: It is up to you.

    If you do not copy and paste, the historical operation logs of the project (logdb) will be lost, and there will be no data under System Management > Platform Log.

    You do not need to copy and paste the file if there is no requirement for historical usage.

    /webroot/WEB-INF/assets/temp_attach

    Function: It stores FineBI-data-table-related information.

    Necessity in copying and pasting: necessary

    The folder stores the project that contains the original Excel files. Not copying this folder will result in the original Excel files being lost.

    /webroot/WEB-INF/assets/vcs

    Function: It stores backup files of FineReport templates.

    Necessity in copying and pasting: It is up to you.

    If the project does not require a rollback of the historical development of the FineReport template, there is no need to copy and paste it.

    /webroot/WEB-INF/assets/other_files

    Function: They store generally shared persistent directories.

    Necessity in copying and pasting: necessary

    The files are required for the normal operation of the project. If you do not copy and paste them, the normal use of the project will be affected.

    /webroot/WEB-INF/classes

    Function: It stores default and custom class files called by the project.

    Necessity in copying and pasting: necessary

    There may be custom class files that, if not copied and pasted, will affect the normal use of the project.

    /webroot/WEB-INF/config

    Function: It stores configuration-database-related files.

    Necessity in copying and pasting: necessary

    It stores the configuration database (finedb) called by the platform. If it is not copied, the normal use of the project will be affected.

    /webroot/WEB-INF/customLib

    Function: It stores JAR packages customized by projects and externally imported JAR packages.

    Necessity in copying and pasting: It is necessary to copy and paste, or the accessing template will be affected.

    /webroot/WEB-INF/dpworks

    Function: It stores the configuration file related to FineDataLink tasks.

    Necessity in copying and pasting: It is necessary to copy and paste, or the FineDataLink usage will be affected.

    (If this folder does not exist, it means that the project does not utilize FDL-related functions, so skip it.)

    /webroot/WEB-INF/embed

    Function: It stores the built-in finedb database that has been/ is currently being used in the project.

    Necessity in copying and pasting: It is necessary to copy and paste for easy rollback, even if an external configuration database is currently being used.

    /webroot/WEB-INF/lib

    Function: It stores the original/externally imported JAR packages. It is the crucial file for the project, which provides all the basic functions of the project.

    Necessity in copying and pasting: It is necessary to copy and paste, or the accessing template will be affected.

    /webroot/WEB-INF/plugins

    Function: It stores plugin-related files.

    Necessity in copying and pasting: It is necessary to copy and paste, or plugin-related functions will be affected.

    /webroot/WEB-INF/reportlets

    Function: It stores FineReport templates.

    Necessity in copying and pasting: It is necessary to copy and paste, or all the templates in the project will be lost.

    /webroot/WEB-INF/schedule

    Purpose: It stores files generated by Task Schedule.

    Necessity in copying and pasting: It is up to you.

    If you do not copy and paste, the result report mounted to the decision-making platform by Task Schedule cannot be accessed.

    Starting the New Project

    Start the new projectFor details, see Closing or Restarting the FineBI Project.

    Migrating the External Database of the New Project

    iconNote:
    If you did not configure the original project with an external database in section "Confirming the Original Project Configuration Database" and only use the built-in database, skip this section.

    If you have configured the original project with an external database in section "Confirming the Original Project Configuration Database", and both the new and old projects are using the same finedb database, the external database of the new project needs to be migrated to another database.

    1. Create an Empty Database

    Create a new database name at the original external database address in the old project, which is the name of an empty database for migration.

    2. Migrating the database

    Log in to the new project as the admin, choose System Management > System Setting > General > To Be Configured/Configured.

    Configure the external database to the empty database in the previous step.

    Select Migrate Data to Database to Be Enabled.

    Click Enable New Database.

    When the prompt "Successfully switched to the target database." is displayed, it means that the external database has been successfully switched.

    Notes

    After the project migration, it is generally required to re-extract the data.

    Log in to the new project first and check and modify the data storage path. (The path of the new server and the old server may differ, make sure it is the path where you need to store the data.) For details, see Data Storage Path.

    Starting the Original Project

    Start the original projectFor details, see Closing or Restarting the FineBI Project.

    Migrating the Authorization

    If the original project has been registered, it is generally required to migrate the authorization to the new project.

    Contact our technical support to obtain an authorization migration plugin and perform operations by referring to the document Authorization Migration Plugin. Deauthorize the original project, and authorize the new project.

    附件列表


    主题: System Management
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy