Independent Deployment of FineReport on Tomcat (Windows)

Version

Application Scenario

Tomcat is a free and stable web application server that is popular among small and medium-sized enterprises.

Function Description

This document introduces how to deploy the FineReport project in the Tomcat container on the Windows system.

Note:

The Linux system is more stable, secure, reliable, and flexible compared to the Windows system. Therefore, you are advised to deploy the FineReport production project on the Linux system. For details, see Independent Deployment of FineReport on Tomcat (Linux).

Notes

This document takes the environment consisting of Windows, Tomcat 9.0.44, and JDK 1.8 as an example. As the commands may vary slightly depending on system and application versions, you need to make adjustments accordingly.

You need to install the JDK and Tomcat on the Windows system in advance. For the installation methods, you can refer to relevant resources. Technical support does not cover environment setup inquiries.

You cannot deploy multiple FineReport projects on a single Tomcat server.

The JDK version needs to be 1.8 with the minor version later than JDK 8u102.

Tomcat 10.0 is not supported.

Note:

You need to install the JDK and Tomcat on the Windows system in advance. For the installation methods, you can refer to relevant resources. Technical support does not cover environment setup inquiries.

Server Preparation

You need to prepare an appropriate server environment based on the user scale of the project. For details, see Supported Environment and Configuration for Standalone Project Deployment.

JDK Installation

When deploying FineReport independently, you need to prepare the JDK on your own.

Procedure	Description
Version	JDK 1.8 with minor versions later than JDK 8u102 is supported. Note:  The bit version of the JDK must match that of the operating system. Although a 32-bit JDK can be installed on a 64-bit system, FineReport does not allow this configuration. In view of this, the bit versions of them must match.
Downloading the JDK	Download link: JDK. You can place the downloaded JDK installation package on the Windows server.
Installing the JDK	For installation instructions, you can refer to the official JDK documentation.

Tomcat Installation

When deploying FineReport independently, you need to prepare Tomcat on your own.

Obtaining the Project File

1. Paid users can contact FanRuan technical support to obtain the corresponding webroot project files. For details about how to contact technical support, see Technical Support Channel Introduction.

2. Free users can refer to Designer Installation to install the designer, and obtain the required webroot project files in the path FineReport installation directory/webapps.

Copying the Project File

1. Compress the obtained webroot folder.

2. Place the compressed file in the path Tomcat installation directory/webapps on the server.

3. Extract the compressed file.

Configuring the Parameter (Optional)

The web application server for deploying the FineReport project must meet specific configuration requirements.

If the web application server does not meet the project requirements, downtime issues may occur.

You are advised to configure the required parameters before starting the Tomcat server.

Note: 

You need to pay special attention to JVM-related setting items first. Other settings can be verified after the project is started.

Modifying the Port Number (Optional)

If multiple Tomcat instances are running on the Windows system, you need to check whether the default port 8080 is already in use. If no project has been deployed on the server before, you can skip this section.

1. You can use the command to check if the default port 8080 is already in use:

netstat -aon|findstr "8080"

2. If it is in use, you need to modify the Tomcat port number. For details, see Tomcat Port Configuration.

Starting Tomcat

1. Enter Tomcat installation directory\bin.

2. Double-click startup.bat or startup.sh in the bin folder to start the Tomcat server.

Note:  

If you used the EXE file (Windows installer) instead of the ZIP file in the "Tomcat Installation" section, you need to double-click Tomcat.exe to start the Tomcat server.

Accessing the Decision-making Platform

Enter the URL http://IP address:Port number/Project name/decision in a browser. If the initial configuration page of FineReport is opened, the deployment is successful, as shown in the following figure.

Note:

1. In the URL, the default port number of Tomcat is 8080, and the default project name is webroot.

2. The username and password are those of the copied project in the "Obtaining the Project File" section. If the project has never been logged in to before, you will enter the initial configuration page directly.

Problem

After being successfully deployed on the Windows system, the project may experience lag and poor performance.

Cause

Starting from Windows Server 2016, Windows updated the console to support more functions similar to Command Prompt.

The new functions can cause serious performance issues with the logs outputted to the console when Tomcat is started in windowed mode on Windows Server 2016, ultimately resulting in lag and degraded performance.

Solution one: keeping the startup window

1. Double-click startup.bat, right-click the title bar in the Tomcat window popping up after the click, select Properties, tick Use legacy console, and click OK, as shown in the following figure.

2. Restart Tomcat.

Solution two: disabling the startup window

1. Go to Tomcat installation directory/bin, open the setclasspath.bat file, and modify set _RUNJAVA="%JRE_HOME%\bin\java.exe" to set _RUNJAVA="%JRE_HOME%\bin\javaw.exe", as shown in the following figure.

2. Save the modification, and restart Tomcat.

Note: 

1. When you start Tomcat using startup.bat, the Command Prompt window just flashes briefly, but the Tomcat service is started successfully. You still need to wait for Tomcat to complete startup before accessing FineReport project.

2. To stop Tomcat started in this way, you must end the Java process in Task Manager.