Overview
Version
Report Server Version | Functional Change |
11.0 | / |
11.0.18 | Optimized the prompt for registration failure, providing specific causes and solutions. |
Demo Video
Functions
Local machine information authentication is the most common authentication method, with simple operations and great convenience.
The physical information of the report server is fixed. You can export the RIF file to obtain a MAC address and machine code to generate a LICENSE file with unique identification.
Notes
1. Local machine information authentication requires the physical information of the report server to be fixed. If it is not fixed, this registration method is not applicable.
For example, if you deploy the report project in a virtual machine environment where the physical information may change, registration failure occurs. You need to use other registration methods.
2. A formal LICENSE file can only be registered once on a machine. If you want to register multiple projects on the same machine, you need to purchase multiple LICENSE files.
3. A formal LICENSE file is only applicable to one server. If you want to change the server, you need to migrate registration information.
4. After FineReport 9.0 is upgraded to V10.0 on the same server, you need to migrate registration information. You are advised to use Authorization Migration Plugin.
5. You need to ensure that the project uses JDK 1.8 and the minor version needs to be JDK 8u200 or later.
6. The MAC address cannot be set to empty (Registration fails in this case as the official LICENSE file forcibly authenticates the MAC address.) or unlimited.
Registration Procedures
Confirming the Project Name
Go to the path %FR_HOME%\webapps\ of the report server to confirm the project name of web. The default name is webroot.
You can modify the project name as needed before registration. It cannot be modified after registration.
1. Modify the project name with caution, because changing it may affect the settings such as the hyperlink of a template.
2. To change the project name is to change the name of this folder. After modification, the address for accessing the project becomes http://IP address:Port number/Project name/decision.
Exporting Registration Information
Start the server of the FineReport project, log in to the decision-making platform as the admin, and choose System Management > Registration Management.
Click Register Now on the Version Information tab page, select Local Machine Info as the authentication method, and click Export Registration Information.
The exported file name is RegistrationInformation.rif, and the file stores the version information of the report project.
Obtaining the License File
Use the email address specified in the contract and send the registration information to FineReport business personnel (business@fanruan.com) who will assist in generating the license. It may take a while. This method is applied to all FanRuan projects. The email format is shown as follows.
After verifying the received email, business personnel will generate a FanRuan.lic license file and email it to you.
Preparation | Content | Notes |
Contact | Contact FanRuan sales personnel in advance to confirm relevant matters and sign the contract. | / |
Sender | Use the email address specified in the contract. | If you do not use the email address specified in the contract to send registration information, the registration will not be allowed. |
Recipient | business@fanruan.com | / |
Title | Official Authorization Document of Company Name's Registration for FineReport | If you do not mark the company name in the email, the registration will not be allowed. |
Body | Company name: Company Name Project name: Project Name Contract signing date: YYYY/MM/DD Registration method: Local Machine Info Project version: Specify the minor project version and the JAR package version, which can be found in System Management > Registration Management > Version Information. | Other information like concurrency and the number of users are registered according to the signed contract. |
Attachment | The aforementioned exported RIF files | Opening the generated RegistrationInformation.rif file will damage it. If you send the damaged file to FanRuan business personnel, the registration will fail. |
Uploading the LIC File
Log in to the decision-making platform as the admin, choose System Management > Registration Management, and click Register Now.
Select Local Machine Info as the authentication method, click Upload License, and upload the obtained FanRuan.lic file.
The registration is successful if the operations above are correct.
Cancelling Registration
1. Go to the path %FR_HOME%/webroot/WEB-INF/resources and delete the FanRuan.lic file.
2. Restart the FineReport project.
Failed Registration
In versions earlier than FineReport 11.0.18, if registration fails, a prompt window pops up: Registration failed, please re-register.
In FineReport 11.0.18 and later versions, the prompt for registration failure has been optimized. If registration fails, a prompt window pops up with the specific causes and solutions or troubleshooting steps.
In a Standalone Environment
If registration fails, a prompt window pops up with the specific causes. You can click Details to view solutions or troubleshooting steps.
You can click Back to return to the registration management page.
In Registration Information, information about registration failure and the causes is displayed. You can click View Error Details to view solutions or troubleshooting steps.
In a Clustered Environment
If registration fails, the causes may vary due to different nodes. A prompt window pops up with the specific causes of failure for each node. You can click Details to view solutions or troubleshooting steps.
You can click Back to return to the registration management page. In Registration Information, causes of failure for each node are displayed in a list format. You can click View Error Details to view solutions or troubleshooting steps.
Summary of Causes
The summary of causes of registration failure are shown as below. You can troubleshoot the problems based on specific causes and error details.
1. In addition to the following causes of failure, other errors are reported uniformly: The certificate content is incorrect.
2. If there are multiple causes of failure in a registration process, only the cause of the first failure is displayed.
Failure Type | Cause |
The LIC file | The LIC file has been damaged, or the version is mismatched. |
The Certificate is expired. Expired date: YYYY/MM/DD | |
The LIC file has been destroyed. | |
Uploading of the LIC file | The uploading of the LIC file fails. |
The uploading of the attachment fails. | |
The upload verification of the LIC file fails. | |
Hardware | The MAC address is mismatched. Local MAC address: Address Authenticated MAC address: Address |
The machine code is mismatched. Local machine code: Code Authenticated machine code: Code | |
Environmental issues | The port 3799 used for authorization is in conflict and the maximum number of authorizations is reached. |
Reminder for License Expired
The reminder appears 15 days before the license expires. Once the reminder period is reached, super admins receive the platform notification every time they log in to the platform.
The content indicates that your authorization license will expire in N days, please re-authorize as soon as possible.