Overview
Version
| Report Server Version | Functional Change |
|---|---|
11.0 | / |
11.0.18 | Optimized the prompt for registration failure, providing specific causes and solutions. |
11.5 | Added project ID export and sending in registration steps. |
| 11.5.9 | Merged project ID with project registration information for export, streamlining registration steps. |
Function Description
Local machine information authentication reads the physical information of the server where the report project is located to generate a uniquely identified license file, thereby completing the authorization and registration.
The entire process consists of three steps: exporting the server MAC address and machine code, sending the information to FanRuan Commercial Team to obtain the license file, and uploading the license file to authenticate the project.
Notes
1. Server physical information must remain fixed. If the project is deployed in a containerized or virtual machine environment, the physical information may change at any time, causing the registration to fail. In such cases, use an alternative authentication method.
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 10.0 to 11.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.
Registration Procedure
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. Back up the relevant data before making modifications, and proceed with caution.
After modification, the address for accessing the project becomes http://IP address:Port number/Project name/decision.
Exporting the Project ID Information (Mandatory for Versions 11.5–11.5.8)
This operation is required for FineReport projects of versions 11.5--11.5.8.
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. Download the appID.rif file generated by the system, which contains the unique ID of the project.
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. For versions 11.5.9 and later, this file also contains the unique ID of the project.
Obtaining the Authorization File
Use the email address specified in the contract to send the registration information to the FanRuan Commercial Team at business@fanruan.com. After verification, the team will generate the FanRuan.lic file and send it to the customer via email.
Note:1. Contact FanRuan Sales to confirm relevant matters and sign the contract before sending the registration email.
2. Specify the special requirements (if any) in the email.
| List | Content | Notes |
|---|---|---|
Priority contact | Contact FanRuan sales personnel in advance to confirm relevant matters and sign the contract. | / |
Sender | Use the email address specified in the contract. | Otherwise, the registration will be rejected. |
Recipient | business@fanruan.com | / |
Title | Official Authorization Document of Company Name's Registration for FineReport | If you do not indicate the company name in the email, the registration will be rejected. |
Body | Company name: Company Name Project name: Project Name Contract signing date: YYYY/MM/DD Registration method: local machine information authentication Project version: Specify the project's full patch version and the JAR package information, which can be found under System Management > Registration Management > Version Information. | Other information, like concurrency and the number of users, will be registered according to the signed contract. |
Attachment | appID.rif exported in the section "Exporting the Project ID Information (Mandatory for Versions 11.5–11.5.8)" | (1) This file is required only for FineReport projects of versions 11.5–11.5.8. (2) Do not open the .rif file with any program. Opening the file will cause corruption, and sending a corrupted file to the FanRuan Commercial Team will lead to registration failure. |
| RegistrationInformation.rif exported in the section "Exporting the Registration Information" | Do not open the .rif file with any program. Opening the file will cause corruption, and sending a corrupted file to the FanRuan Commercial Team will lead to registration failure. |
Uploading the LIC File
(1) 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.
(2) Select Local Machine Info as Authentication Method, click Upload License, and upload the obtained FanRuan.lic file, as shown in the following figure.
(3) The registration will be successful if the operations above are correct.
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.
Cancelling Registration
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 to make the unregistration take effect.
Failed Registration
In versions earlier than FineReport 11.0.18, if registration fails, a prompt window "Registration failed. Register again." will pop up, without displaying the causes.
In FineReport 11.0.18 and later versions, 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.
Summary of Causes
The error message for all other failure causes not mentioned in the following table is “Incorrect License Format”.
If the registration fails for multiple causes, only the cause for the initial failure will be displayed.
| Failure Type | Failure Cause |
|---|---|
License file issue | License File Corruption or Version Mismatch |
License Expired on xxx | |
License File Destroyed | |
License upload issue | License Upload Failure |
License Attachment Upload Failure | |
Upload Verification Failure of License File | |
Project information issue | MAC Address Mismatch Local MAC Address: xxx Authentication MAC Address: xxx |
Machine Code Mismatch Local Machine Code: xxx Authentication Machine Code: xxx | |
The app project ID in the license does not match that in the project. App Project ID in the Project: xxx App Project ID in the License: xxx | |
Environment issue | There is a conflict in the license-used port xxx. The maximum number of nodes for which licenses can be assigned has been reached. |
Reminder for License Expired
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). Reapply for a license as soon as possible. The following figure shows the reminder.
Upon receiving the reminder, contact the FanRuan Commercial Team immediately for renewal to avoid any interruption to normal use after the license expires.
Previous：Public Cloud Authentication
