Private Cloud Authentication

Version

Application Scenario

Since your FineBI server is deployed on a virtual machine/cloud platform and the physical information of the FineBI server is not fixed, the fixed machine information cannot be bound. Therefore, the local machine information authentication is no longer applicable.

In this case, you need to find a server with fixed physical information as the authorization server and send the machine information rif file of the authorization server to the business personnel who will generate a server file named FanruanLicenseServer (including a file named server.exe) for the private cloud authentication.

Function Description

Since the physical information of the FineBI server is not fixed, the local machine authentication cannot be used. In this case, you can perform the private cloud authentication through a server with fixed physical information.

The authorization server (namely the License Server side) returns the authorized function point, authorized access domain, authorized access port number, authorized access application name, and authorized access expiration date to the FineBI server (namely the Report Server side).

The FineBI server performs verifications. If verifications are passed, the normal access program will be performed. If not, the server is unauthorized, as shown in the following figure.

The license server program refers to the server program that provides authentication functions (physical information needs to be provided). The FineBI server refers to a server on which FineBI is running (physical information is not required).

Notes

1. The authorization server for the private cloud authentication needs to be a machine with fixed physical information. The machine where the FineBI server is located cannot be used as the authorization server because the machine does not have fixed physical information. For example, physical information of the machine may change in the virtual machine environment, causing a registration failure.

2. Network interconnectivity is needed between the FineBI server (namely the server on which the to-be-registered FineBI project is located) and the authorization server.

3. An authorization server cannot run two private cloud authentication programs.

4. The authentication program (run by the authorization server) cannot be closed for more than 24 hours.

• If you close the program for more than 24 hours, you need to re-run the authentication program and re-perform the registration for the report server.

• If you close the program for less than 24 hours and the report server fails to be registered, you can reconnect the report server with the authorization server in two hours. If the connection is successful, the registration will still be valid.

5. If you need to use the machine (where the authentication server is located) as the authorization server again after the authentication server is uninstalled, you need to regenerate the MachineInfo.rif file and send it to the business personnel for re-registration.

6. Within the allowed number of authorizations, an authorization server can grant authorizations to multiple FineBI servers.

7. When using the private cloud authentication in a cluster, you do not need to send the registration information of each node to the business personnel.

8. When migrating the FineBI server, you do not need to reapply for the authorization file. You only need to ensure that the machine (where the FineBI server is located) shares the same network with  the authorization server.

9. Systems i386, ARM, and AMD64 are supported on Linux.

10. You cannot access the private cloud through NAT.

Downloading the machine Tool

You can download the machine tool for obtaining the information file of the authorization server: Windows.zip.

Upload the downloaded file to the authorization server and decompress the file.

Exporting Information of the Authorization Server

Run the generated machine.exe file as the admin. The require folder is automatically generated in the same directory.

The MachineInfo.rif file in the require folder is the exported information file of the authorization server, as shown in the following figure.

Obtaining Version Information

Log in to the FineBI system as the admin and choose System Management > Registration Management > Version Information to obtain the complete screenshot of version information, as shown in the following figure.

Obtaining the Authorization File

You can obtain the authorization file with the help of the business personnel.

Send an email to FanRuan's business personnel who will generate an authorization file. You can apply for the authorization file of any FanRuan projects, but you need to wait patiently as it may take a while.

Send the registration information through the email address specified in the contract to FineBI business personnel (business@fanruan.com). The following table describes the email format.

After receiving the email and verifying the information, the business personnel will generate an authorization file named FanruanLicenseServer.zip and send the file to you by email.

Note:

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

Starting the Authorization Server

Decompress the obtained authorization file (FanruanLicenseServer.zip) on the authorization server.

Run the server.exe file in the bin folder as the admin, as shown in the following figure.

Note:

1. If the startup fails with an error indicating an occupied port, you can add -Port number behind the program (such as .server.exe -port 8088) to specify another port number when starting the program through the command line.

2. You can specify a language (such as .server.exe -port 8088 -language en) for the server.exe file when starting the authentication server. Simplified Chinese is the default language and English is also available.

Setting Automatic Startup for the Service at Boot

The executable file running on the authorization server cannot be closed. That is, the server.exe file on Windows cannot be closed. If you close this file, you need to perform the re-registration by referring to section "Obtaining the Authorization File" when reopening the file.

Configure the automatic startup service at boot for \FanruanLicenseServer\bin\server.exe.

Note:

After successful setup, the program can be started automatically at boot. If you need to change the private cloud, you need to stop the previous one first.

Verifying the Authorization on the FineBI Server

Log in to the FineBI system as the admin, choose System Management > Registration Management, and click Register Now, as shown in the following figure.

Set Authentication Method to Private Cloud, set Server Address (https://host:Port number  in which host is the IP address and Port number is the listening port number of the authorization server, such as https://172.17.0.25:8081), and click Submit, as shown in the following figure.

Note:

1. If the domain name of the authorization server is provided, enter the domain name. If the domain name is not provided, enter the IP address.

2. Ensure that the FineBI server can access the authorization server.

The following figure shows the effect of the successful authentication.

Note:

1. The maximum number of connections represents the maximum number of projects for which you can apply for authorization registrations to the authorization server at the same time.

2. If the authentication fails, you need to check the firewall setting (to open the corresponding port or disable the firewall).

Downloading the machine Tool

You can download the corresponding machine tool in the following table to obtain the information file of the authorization server.

Note:

 In general, the 64-bit Linux uses the AMD64 processor and the 32-bit Linux uses the i386 processor.

If the physical machine uses the RISC and low-power CPU (rare cases), ARM needs to be used. In short, the use of processors depends on the used hardware.

Exporting Information of the Authorization Server

Note:

The operations in this section must be performed by the admin account, otherwise the startup authorization program will report an error indicating that the machine code is not matched.

Take Linux_AMD64 as an example.

Upload the compressed file to the authorization server and decompress the file to generate the machine.file file.

unzip linux_amd64.zip

Add permissions to the machine.file file.

chmod 777 machine

Run the machine.file as the admin. The information file (namely the MachineInfo.rif file in the require folder) of the authorization server is automatically generated.

./machine

Obtaining Version Information

Log in to the FineBI system as the admin and choose System Management > Registration Management > Version Information to obtain the complete screenshot of version information, as shown in the following figure.

Obtaining the Authorization File

You can obtain the authorization file with the help of the business personnel.

Send an email to FanRuan's business personnel who will generate an authorization file. You can apply for the authorization file of any FanRuan projects, but you need to wait patiently as it may take a while.

Send the registration information through the email address specified in the contract to FineBI business personnel (business@fanruan.com). The following table describes the email format.

After receiving the email and verifying the information, the business personnel will generate an authorization file named FanruanLicenseServer.zip and send the file to you by email.

Note:

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

Starting the Authorization Server

Note:

If the server is connected by a tool, you need to use exit to log out the session after using the command line nohup ./bin/server &.

After re-login, you can use the command ps -ef|grep server to check whether the server is running in the backend. If so, the private cloud backend has been started successfully and will be running as long as the server is not closed.

1. Decompress the obtained authorization file (FanruanLicenseServer.zip) on the authorization server.

unzip FanruanLicenseServer.zip

2. After decompression, run the server.exe file in the bin folder as the admin.

nohup ./server &

Note:

You can specify a language (through the command such as ./server -language en) for the server.exe file when starting the authentication server. Simplified Chinese is the default language and English is also available.

3. The following figure shows the successful startup of the authentication server.

Verifying the Authorization on the FineBI Server

Log in to the FineBI system as the admin, choose System Management > Registration Management, and click Register Now, as shown in the following figure.

Set Authentication Method to Private Cloud, set Server Address (https://host:Port number in which host is the IP address and Port number is the listening port number of the authorization server, such as https://172.17.0.25:8081), and click Submit, as shown in the following figure.

Note:

1. If the domain name of the authorization server is provided, enter the domain name. If the domain name is not provided, enter the IP address.

2. Ensure that FineBI server can access the authorization server.

The following figure shows the effect of the successful authentication.

Note:

1. The maximum number of connections represents the maximum number of projects for which you can apply for authorization registrations to the authorization server at the same time.

2. If the authentication fails, you need to check the firewall setting (to open the corresponding port or disable the firewall).

Downloading the machine Tool

You can download the machine tool to obtain the information file of the authorization server: Mac.zip.

Exporting Information of the Authorization Server

Upload the compressed file to the authorization server and decompress the file to generate the machine.file file.

unzip Mac.zip

Add permissions to the machine.file file.

chmod 777 machine

Run the machine.file as the admin. The information file (namely the MachineInfo.rif file in the require folder) of the authorization server is automatically generated.

./machine

Obtaining Version Information

Log in to the FineBI system as the admin and choose System Management > Registration Management > Version Information to obtain the complete screenshot of version information, as shown in the following figure.

Obtaining the Authorization File

You can obtain the authorization file with the help of the business personnel.

Send an email to FanRuan's business personnel who will generate an authorization file. You can apply for the authorization file of any FanRuan projects, but you need to wait patiently as it may take a while.

Send the registration information through the email address specified in the contract to FineBI business personnel (business@fanruan.com). The following table describes the email format.

After receiving the email and verifying the information, the business personnel will generate an authorization file named FanruanLicenseServer.zip and send the file to you by email.

Note:

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

Starting the Authorization Server

Note:

Do not close the executable file running on the authorization server. That is, the server on macOS cannot be closed.

Decompress the obtained authorization file (FanruanLicenseServer.zip) on the authorization server.

Run the server.exe file in the bin folder as the admin, as shown in the following figure.

Note:

You can specify a language (through the command such as ./server -language en) for the server.exe file when starting the authentication server. Simplified Chinese is the default language and English is also available.

Verifying the Authorization on the FineBI Server

Log in to the FineBI system as the admin, choose System Management > Registration Management, and click Register Now, as shown in the following figure.

Set Authentication Method to Private Cloud, set Server Address (https://host:Port number in which host is the IP address and Port number is the listening port number of the authorization server, such as https://172.17.0.25:8081), and click Submit, as shown in the following figure.

Note:

1. If the domain name of the authorization server is provided, enter the domain name. If the domain name is not provided, enter the IP address.

2. Ensure that FineBI server can access the authorization server.

The following figure shows the effect of the successful authentication.

Note:

1. The maximum number of connections represents the maximum number of projects for which you can apply for authorization registrations to the authorization server at the same time.

2. If the authentication fails, you need to check the firewall setting (to open the corresponding port or disable the firewall).

Problem

If the registration fails, a prompt window pops up, as shown in the following figure.

Cause

Click Details to view causes of the registration failure. You can troubleshoot possible problems based on specific causes.

Note:

In addition to the above causes, errors caused by other causes are uniformly displayed as Incorrect License Format.

Multiple causes (if any) will all be displayed on the platform.

Uninstalling the Authorization Server

To migrate the authorization server, you need to first uninstall the current authentication server. Open the bin folder as the admin and run the server.exe. file.

On Windows

On the Windows system, open the command prompt (cmd), go to the bin directory, and run the following command, as shown in the following figure.

.\server.exe -destroy

On macOS and in Linux

On Mac and in Linux systems, run the following command, as shown in the following figure.

./server -destroy

Obtaining the Uninstallment-Proving File

After the command is executed, the license of the current server will be uninstalled. You will obtain a proving file, as shown in the following figure.

Note:

Sometimes Windows may report errors. In this case, you need to create a folder named uninstall in the folder with the same level as the bin folder. The uninstalled file will be placed in the uninstall folder.

Re-registration

Send the receipt.fr file and the MachineInfo.rif file (regenerated based on the steps of applying for the authentication server) to the FanRuan business personnel.

After receiving, verifying, and destroying the receipt.fr file, the business personnel will send a new server authentication file to you by email.

Note:

After the authorization server is destroyed, if you restart the FineBI server, the registration will immediately fail. If you do not restart the FineBI server, the registration will fail in 24 hours.