Deploying the FineBI Project Locally in Tomcat Container on Windows

  • Last update:  2023-03-29
  • Overview

    Version

    FineBI Server Version

    Functional Change

    6.0

    /

    Application Scenarios

    Tomcat is a free and stable web application server, popular among many small and medium enterprises.

    Functions

    This article introduces how to deploy the FineBI project to the Tomcat container in the Windows system.

    Notes

    • Multiple FineBI projects cannot be deployed in the same Tomcat server.

    • The JDK version needs to be 1.8 and the minor version needs to be JDK 8u102 or higher.

    • Not support 32-bit operating systems.

    • Not support Tomcat 10.0.

    Deployment Procedure

    Preparing a Server

    Please prepare a suitable server environment according to the data volume and number of users of the project. For details, see FineBI Server Configuration Recommendation.

    Deployment on 32-bit operating systems of Windows is not supported.

    Installing JDK

    When deploying locally, you need to prepare JDK separately.

    1. Download and install JDK

    Procedure

    Description

    Version requirements

    Support JDK 1.8 and the minor version needs to be JDK 8u102 or higher.

    FineBI does not support the 32-bit operating system, you need to download 64-bit JDK.

    Download JDK

    Download link: JDK.

    Install JDK

    For the installation procedure, see official JDK help documents.

    When configuring path in installing configure environment variables, you are advised to add  to the variable value.

    2. Check whether the JDK is installed successfully

    Press the Win+R key, and enter cmd to call the command terminal.

    Enter java -version and javac. If the following text appears, it means successful JDK installation.

     

    Installing Tomcat

    When deploying locally, you need to prepare Tomcat separately.

    1. Download and install Tomcat.

    Procedure

    Description

    Version requirements

    Support Tomcat 8.0 (not support Tomcat 8.0.32 version)

    Support Tomcat 9.0

    Not support Tomcat 10.0

    Download Tomcat

    Download link: Tomcat, select 64-bit Windows zip.

    • tar.gz is the Linux system installation file.

    • 32-bit Windows zip is an installation package for the 32-bit version of Windows.

    • 64-bit Windows zip is an installation package for the 64-bit version of Windows.

    Install Tomcat

    For installation procedure, see Tomcat official help documents.

    • If you have installed multiple Tomcats in your environment, it is not recommended to configure CATALINA_HOME or TOMCAT_HOME in your environment variable. Otherwise, no matter which Tomcat you start, only the one specified by CATALINA_HOME will start.

    • Multiple FineBI projects cannot be deployed in the same Tomcat server.

    2. Check whether Tomcat is installed successfully.

    Double-click startup.bat in the directory %Tomcat_HOME%\bin to start the Tomcat server.

    Enter the command http://localhost:8080 in the browser, if you see the following page, the installation is successful:

    Note: The built-in log management of the platform cannot clean up the log files in the logs folder under %TOMCAT_HOME%/. The catalina.out file will take up much disk space if it runs for a long time. It is advised to clean up the catalina.out file regularly.

    Copying FineBI Project

    Copy the folder webroot to %Tomcat_HOME%\webapps.

    Notes

    1.The folder webroot can be obtained under the installation directory %FineBI%\webapps after installing the FineBI trial version.

    2. The name of folder webroot is the FineBI project name.

    You can customize the name. If you want to access the FineBI project later, the project name in the address http://ip:{port}/{project name}/decision should also be changed accordingly.

    Copying tools.jar

    Copy the tools.jar under the JDK installation directory %JAVA_HOME%\jdk\lib to %Tomcat_HOME%\lib and %Tomcat_HOME%\webapps\{project name}\WEB_INF\lib.

    Note: If you do not perform this operation, when accessing the FineBI project, the page will display an error message: HTTP Status 404.

    Configuring Memory Parameters

    FineBI has configuration requirements for the server, so you need to configure memory parameters to ensure stability of the server.

    For details: see Modifying FineBI Configuration Parameters.

    Note: If you do not configure the headless parameter of Modifying FineBI Configuration Parameters, an error message will be prompted when the super admin exports Excel: No Export Permission.

    Configuring JVM Parameters

    Application scenarios

    To manage the operation and maintenance of the Tomcat server, you are advised to configure the JVM parameters that automatically generate dump logs.

    Configuring this parameter will not damage project's performance, and is only used to generate dump logs when the server is down.

    Operation methods

    Go to the directory %Tomcat%\bin, edit the configuration file catalina.bat, and add JVM parameters.

    After modification, restart Tomcat to make it take effect.

    set JAVA_OPTS=%JAVA_OPTS% -server -XX:+HeapDumpOnOutOfMemoryError -XX:HeapDumpPath=D:\heapdump

    Note: The path D:\heapdump indicates the path for generating files in downtime. You can modify it.

    Starting the Tomcat Server

    Double-click the file startup.bat in the directory %Tomcat_HOME%\bin to start the Tomcat server.

    Accessing FineBI Project

    Enter the URL http://IP:{port}/webroot/decision in the browser. For example, if you enter http://localhost:8080/webroot/decision, the FineBI project login page will appear, meaning successful deployment.

    Notes

    0day Vulnerability Warning

    If you meet a 0day vulnerability warning notification, see: 0day Vulnerability Explanation.

    Poor Performance

    Description

    After successfully deploying the project in the Windows system, you face a lagging problem.

    Cause

    In Windows Server 2016 and newer versions, Windows has updated the functions of the console, supporting more functions similar to the cmd window.

    When you start Tomcat deployed in Windows Server 2016, FineBI has lagging issues as these new functions cause poor performance for console logs.

    Solution one: keep the startup window

    1. After double-clicking startup.bat, right-click the top white bar in the pop-up Tomcat window, select Properties, tick Use old version console, and click OK.

    2. Restart the Tomcat project.

    Solution two: disable the startup window

    1. Go to the directory %Tomcat_HOME%\bin, find the file setclasspath.bat, and change set _RUNJAVA="%JRE_HOME%\bin\java.exe" to set _RUNJAVA="%JRE_HOME%\bin\javaw.exe".

    2. Restart the Tomcat project after saving.

    Notes

    1. Use startup.bat to start Tomcat, the command window will flash by quickly, but the service has already started. To access the project, you need to wait for Tomcat to start.

    2. In this case, if you want to stop Tomcat, you can only go to the task manager to kill the java process.

    附件列表


    主题: Deployment and Integration
    • 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