Overview
Version
Report Server Version | Functional Change |
11.0 | / |
11.0.18 | Optimized the prompt for registration failure, providing specific causes of the failure to help users troubleshoot the problem. |
Demo Video
Application Scenarios
You may need to register multiple projects without setting up an authorization server locally, which makes it troublesome to export project information multiple times.
FineRuan has built a public cloud authentication server. You can initiate authorization requests by filling in authentication information, and send the requests to the public cloud authentication server for unified verification.
Functions
Public cloud registration has the following features:
1. Report projects can be registered on public clouds, which are not limited by physical information. Changes in physical information will not cause registration failures.
2. Your report server must be connected to the authorization server through the public network, otherwise public cloud registration cannot be used.
Therefore, you need to open the external network addresses:
Domain Name | Port | Explanation |
https://register.fanruan.com | 443 | Public cloud authentication server |
https://cloud.fanruan.com | 443 | Website management center |
3. Your registration is unlikely to fail because of easy registration operation.
4. You can apply for an authorization to register multiple projects. The price fluctuates according to the maximum registration capacity.
5. Public cloud can be flexibly registered on any report server.
Notes
The report project performs a query authentication for the public cloud authentication server every 2 hours. If authentication fails for 12 consecutive times (namely after 24 hours), the report project displays registration failure and requires re-registration.
In FineReport 11.0.18 and later versions, the Registration Management page in System Management displays the time and cause of each authentication failure in a list format, thus helping users troubleshoot issues.
Note:Registration Procedures
Obtaining the Authorization 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 an account and the password for you and email them to you.
Note:Preparation | Requirement | 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 | Basic information | Company name: Company Name Project name: Project Name Contract signing date: YYYY/MM/DD | / |
Registration method | Public cloud authentication | / | |
Maximum number of registration | Number of projects allowed to be registered | If this option is not provided, the number defaults to 1. | |
| Project version | Specify the minor project version and the JAR package version, which can be found in System Management > Registration Management > Version Information. | / | |
Account | Name of the public cloud account | If you need to specify a public cloud account name, indicate this in the email. The already used account name is not allowed during registration. If you do not specify/specify an unavailable public cloud account name, business personnel will randomly generate an account for you. | |
Registration Verification
Log in to the decision-making platform as the admin, choose System Management > Registration Management, and click Register Now.
Select Public Cloud as AUTH Method, enter the account and password from the email sent by business personnel, and click Submit.
FineReport defaults to encrypting and storing public cloud passwords through RSA. If you switch encryption algorithms, the password is updated synchronously.
Failed Registration
In versions earlier than FineReport 11.0.18, if registration fails, a prompt window pops up: Authentication failed, please re-authenticate.
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, which can help you troubleshoot problems.
In a Standalone Environment
If registration fails, a prompt window pops up with the specific causes. You can click Details to view troubleshooting solutions.
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 troubleshooting solutions.
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 troubleshooting solutions.
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 troubleshooting solutions.
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.
Note: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.
Error Code | Error Name | Explanation |
10000 | JSON_PARSER_ERROR | Data format is incorrect. |
10001 | PARAM_INPUT_ERROR | The entered parameter is incorrect. |
20000 | DO_NOT_NEED_DEACTIVATE | This machine (unauthorized) does not need to be unbound. (If this prompt appears when you unbind, it means that this machine does not need to be unbound because it is not authorized.) |
20001 | MYSQL_UPDATE_ERROR | Error occurs when you update MYSQL database. |
20002 | REDIS_UPDATE_ERROR | Error occurs when you insert data into REDIS database. |
30000 | LICENSE_EXPIRED | The certificate has expired. |
30001 | REPORT_VERSION_ERROR | The version is mismatched. |
30002 | ACCOUNT_STATUS_ERROR | The account status is abnormal. |
30003 | LICENSE_IP_ERROR | IP address is not within the allowed range. |
30004 | LICENSE_DOMAIN_ERROR | The domain name is not within the allowed range. |
30005 | LICENSE_APPNAME_ERROR | The App name is not within the allowed range. |
30006 | ACCOUNT_INPUT_ERROR | The account and password are not authorized. |
30007 | REGISTER_OUT_OF_LIMIT | The maximum number of authorizations has been reached. |
/ | Engineering server fails to connect to cloud registration server. | / |
Migrating Registration Information
The maximum number of registration is specified in your received email.
1. When the number of servers does not exceed the maximum number of registration, you can use the public cloud account of the original server to register directly on the new server.
2. If the maximum number of registrations is exceeded, after unbinding the public cloud account of the original server, you can use the public cloud account of the original server to register on the new server.
Log in to the decision-making platform as the admin, choose System Management > Registration Management > Version Information > Re-register, and click Unbind to unbind to the original server.
Note:1. After the original server has been shut down for more than 24 hours, you can start registration on a new server, otherwise the original one still occupies the registration number.
2. If the original server is not unbound, and you use the public cloud account of the original server to register on the new server, registration fails with a prompt, indicating that the maximum number of authorizations has been reached.
