Local Machine Information Authentication

Version

Function Description

Local machine information authentication is the most common authentication method, allowing you to complete the authentication easily and conveniently.

The physical information of the server hosting the FineReport project is fixed. You can export the RIF file to obtain the MAC address and machine code, which are used to generate a license file with a unique identifier.

Notes

1. Local machine information authentication requires the physical information of the report server to be fixed. If the physical information is not fixed, this registration method is not applicable.

For example, if the project is deployed on a virtual machine, the physical information may change, causing the registration to fail. In this case, you need to use other registration methods.

2. A formal license file can be registered only once on a single machine. If you want to register multiple projects on the same machine, you need to purchase multiple licenses.

3. A formal license file is valid for only one server. If you want to change the server, you need to migrate the registration information.

4. After upgrading a FineReport project across major versions (such as from 9.0 to 10.0) on the same server, you need to migrate the registration information. In this case, you are advised to use the License Migration Plugin.

5. Ensure that the project uses JDK 1.8 with an update release of 8u200 or later.

6. The MAC address cannot be left empty or set to unrestricted. The official license file enforces MAC address validation; therefore, the registration will fail if the MAC address is left empty.

Confirming the Project Name

Open the FineReport project installation directory FineReport installation directory/webapps, and confirm the project name (webroot by default).

You can modify the project name as needed before registration. After successful registration, the project name cannot be modified.

Note:

Modifying the project name may affect settings such as template hyperlinks. Proceed with caution.

You can modify the project name by modifying the name of the webroot folder. After modification, the address for accessing the project becomes http://IP address:Port number/Project name/decision.

Exporting the Project ID Information (Optional)

This operation is required for FineReport projects of version 11.5 and above.

1. Log in to the FineReport system as the admin, and click System Management > Registration Management.

2. Click Export ID after App Project ID in the Project Information area.

3. The exported file is named appID.rif and contains the project's ID information.

Exporting the Registration Information

1. Log in to the FineReport system as the admin, and click System Management > Registration Management.

2. Click Register Now after Version Registration in the Registration Information area.

3. Select Local Machine Info as Authentication Method, and click Export Registration Information.

4. The exported file name is RegistrationInformation.rif, and the file stores the version and local machine information of the project.

Obtaining the Authorization File

Use the email address specified in the contract to send the registration information to FineReport business personnel (business@fanruan.com). The email format is shown as follows.

After verifying the received email, business personnel will generate a FanRuan.lic file and email it to you.

Note:

Specify the special requirements (if any) in the email.

Uploading the LIC File

After receiving the FanRuan.lic file returned by the business personnel, you can log in to the FineReport system as the admin and click System Management > Registration Management > Register Now, as shown in the following figure.

Select Local Machine Info as Authentication Method, click Upload License, and upload the obtained FanRuan.lic file, as shown in the following figure.

The registration will be successful if the operations above are correct, as shown in the following figure.

Note:

The FanRuan.lic file is automatically saved to the resources directory in the FineReport installation directory/webroot/WEB-INF path.

For cluster projects, this file is stored in the resources folder of the cluster file server.

1. Go to the resources directory in the FineReport installation directory/webroot/WEB-INF path and delete the FanRuan.lic file, as shown in the following figure.

Note:

1. For cluster projects, this file is stored in the resources folder of the cluster file server.

2. Check whether the file server type supports transmission operations such as backend deletion. For storage servers compatible with the Simple Storage Service (S3) Protocol, for example, MinIO, some operations must be performed via the frontend interface after you log in through a browser.

2. Restart the FineReport project.

In versions earlier than FineReport 11.0.18, if registration fails, a prompt window "Registration failed. Register again." will pop up.

In FineReport 11.0.18 and later versions, the prompt for registration failure has been optimized. If registration fails, a prompt window will pop up with the specific causes and solutions or troubleshooting steps.

Failed Registration in Standalone Environment

If the registration fails, a prompt window will pop up with the specific failure cause. You can click Details for solutions or troubleshooting steps, as shown in the following figure.

You can click Back to return to the Registration Management page. In the Registration Information area, information about the registration failure and the causes is displayed. You can click View Error Details for solutions or troubleshooting steps.

Failed Registration in Cluster Environment

If the registration fails, the causes may vary across different nodes. A prompt window will pop up with the specific failure cause for each node. You can click Details for solutions or troubleshooting steps, as shown in the following figure.

You can click Back to return to the Registration Management page. In the Registration Information area, failure causes for all nodes are displayed in a list. You can click View Error Details for solutions or troubleshooting steps.

Summary of Causes

The following table summarizes the causes for registration failure. You can troubleshoot based on the specific causes and the error details.

Note:

1. The error message for all other failure causes not mentioned in the following table is “Incorrect License Format”.

2. If the registration fails for multiple causes, only the cause for the initial failure will be displayed.

Reminder: Reminders are triggered 15 days before the license expiration date. Once the reminder period starts, the super admin will receive a platform notification upon each login.

Content: Your license will expire in N day(s). Re-apply for a license as soon as possible. The following figure shows the reminder.