1. 概述
1.1 版本
BI伺服器版本 | JAR包 | 功能變更 |
---|---|---|
5.1 | - | - |
5.1.17 | 2021-10-14 | 啟動私有云認證伺服器時,支援指定英文語言 |
1.1 應用場景
客戶的 FineBI 伺服器是部署在虛擬機上或者雲平台上的,FineBI 伺服器的物理資訊不固定,這樣就沒有辦法綁定固定的機器資訊,所以本地機器資訊認證不再適用。
這時,需要找一臺物理資訊固定的伺服器作為授權伺服器,然後把授權伺服器的機器資訊 rif 檔案發給商務,生成私有云認證伺服器檔案FanruanLicenseServer,裏面包含一個server.exe檔案。
1.2 功能簡介
FineBI 伺服器物理資訊不固定無法進行本地機器認證時,若有一臺物理資訊固定的伺服器,可進行私有云認證。
授權伺服器(license Server 端)將這個授權的功能點、授權存取域名、授權存取埠、授權存取應用名、授權存取截止日期等資訊傳回給 FineBI 伺服器(Report Server 端)。
FineBI 伺服器(Report Server 端)做校驗,如果校驗透過,就進入正常的存取過程,如果不透過,則作為未授權伺服器。如下圖所示:
授權伺服器過程是指的是提供授權功能的那個伺服器過程(需提供物理資訊), FineBI 伺服器是指運作 FineBI 工程的某臺伺服器(無需提供物理資訊)。
1.3 注意事項
1)私有云認證的授權伺服器,需要是一臺固定物理資訊的機器。FineBI 工程伺服器所在機器不需要有固定不變的物理資訊。
例如虛擬機環境下物理資訊可能變化,造成注冊失敗,不適合被用作授權伺服器。
2)FineBI 伺服器即需注冊的 FineBI 工程所在伺服器,需要跟授權伺服器網路互通。
3)一個授權伺服器不允許運作兩個私有云認證過程。
4)授權伺服器運作的認證過程不可關閉超過 24 小時。
若關閉時長超過 24 小時,需重作認證過程,報表伺服器需要重新進行注冊操作。
若關閉時長小於 24 小時,報表伺服器顯示注冊失敗,在 2 小時內將自動重新連結上授權伺服器,注冊不失效。
5)認證伺服器卸載後,如需再次採用此機器作為授權伺服器,需重新生成 MachineInfo.rif 檔案傳送給商務重新注冊。
6)在授權個數允許的範圍內,一個授權伺服器可以給多個 FineBI 伺服器授權。
7)叢集情況下使用私有云認證,無需每個節點都傳送注冊資訊到商務。
8) FineBI 伺服器遷移時,不需要重新申請授權檔案,只需保證 FineBI 伺服器所在的機器和授權伺服器的網路可以連通即可。
9)Linux 情況下支援 i386、arm 和 amd64 位系統 。
10)不支援透過nat存取私有云。
2. 授權伺服器為 Windows 系統
2.1 下載 machine 工具
點選下載 machine 工具,用於獲取授權伺服器資訊檔案:Windows.zip
將壓縮包上傳至授權伺服器,並解壓。
2.2 匯出授權伺服器資訊
以管理者權限運作解壓生成的 machine.exe 檔案,在同目錄下自動生成 require 資料夾。
require 資料夾下的 MachineInfo.rif 檔案,即為匯出的授權伺服器資訊檔案。如下圖所示:
2.3 獲取授權檔案
請使用合同中指定的郵箱傳送注冊資訊給 FineBI 商務business@fanruan.com,郵件格式如下:
商務收到郵件,覈實無誤後會生成授權檔案FanruanLicenseServer.zip,以郵件方式傳送給使用者。
郵件內容如下表所示:
清單 | 内容 | 注意事項 | |
---|---|---|---|
優先聯絡 | 請提前聯絡帆軟銷售,應答相關事項並簽署合同 | - | |
發件人 | 請使用合同中指定的郵箱 | 如傳送注冊資訊的郵箱,非合同中指定的郵箱,則不予注冊 | |
收件人 | business@fanruan.com | - | |
標題 | XXX 公司注冊 FineBI 正式授權檔案 | 如傳送注冊資訊時,未註明公司名稱,則不予注冊 | |
正文 | 基礎資訊 | 公司名稱:XXX 公司 專案名稱:XXX 專案 合同簽定日期:XXXX年XX月XX日 | - |
注冊方式 | 私有云認證 | ||
FineBI 伺服器版本 | FineBI 工程的版本 | 如傳送注冊資訊時,未註明版本,則不予注冊 | |
FineBI 伺服器IP | 哪些 FineBI 伺服器的 IP允許被注冊,為 FineBI 伺服器的內網 IP 例如:192.168.100.25-192.168.100.26、192.168.0.1 | 如傳送注冊資訊時,未註明 FineBI 伺服器IP,則不予注冊 「FineBI 伺服器 IP 網段」範圍為:1.0.0.0-255.255.255.255 | |
FineBI 工程名 | 允許授權的工程名,例如:report1、report2 | 若不提供,表示對此項不進行限制 | |
授權伺服器域名 | 為授權伺服器的域名 不提供則要保證 FineBI 伺服器可以透過 IP 存取授權伺服器 格式:www.baidu.com、www.google.com | - | |
授權伺服器公網 IP | 若 FineBI 伺服器需要透過授權伺服器的公網 IP 存取,還需提供授權伺服器公網 IP | - | |
授權個數 | 一個授權伺服器可以同時給多個 FineBI 伺服器授權 這裏是限制同時注冊的 FineBI 伺服器的個數 | - | |
附件 | MachineInfo.rif | - |
2.4 啟動授權伺服器
在授權伺服器上,解壓商務傳送的授權檔案壓縮包 FanruanLicenseServer.zip。
以管理者權限運作 bin 目錄下的 server.exe 檔案。如下圖所示:
注1:若啟動失敗,報錯的原因是埠被佔用,那麼使用命令行啟動過程的時候,後面加參數-port 埠指定另外埠。
範例:.server.exe -port 8088
注2:2021-10-13 及之後獲取的 server.exe 檔案,支援啟動認證伺服器的時候指定語言,預設簡體中文,額外提供英文。
啟動命令範例:.server.exe -port 8088 -language en
2.5 設定服務開機自啟動
授權伺服器上的運作的可執行檔案不能關閉,即 Windows下server.exe不能關閉。如果 Server 關掉,重新開啟是未注冊的,需要重新操作一次。
下載 SrvanyUI 服務管理工具:SrvanyUI_1.0.rar,解壓後,運作SrvanyUI_1.0.exe檔案並安裝 SrvanyUI。
開啟 SrvanyUI 軟體,選擇「檔案>增加」,新增「自建服務」。
服務名稱為「私有云授權伺服器」,內部標識為「PrivateServer」,過程路徑選擇上文的\FanruanLicenseServer\bin\server.exe檔案,啟動方式為「自動」。
如下圖所示:
點選確定運作即可,如下圖所示:
注:設定成功後,服務會開機自啓,若需要更換私有云,需要先把之前的停止。
2.6 BI 伺服器驗證授權
FineBI 工程部署在 FineBI 伺服器上,管理者登入數據決策系統,點選「管理系統>注冊資訊>版本資訊」,點選「立即注冊」。
認證方式選擇「私有云認證」,伺服器位址填寫上面授權伺服器顯示的 IP 和監聽埠,例如https://172.16.63.131:8081,點選「提交認證」,如下圖所示:
注1:若提供了授權伺服器域名,則填寫授權伺服器域名,若未提供授權伺服器域名,則填寫 IP 。
注2:請確定 FineBI 伺服器可以存取授權伺服器。
認證成功後,如下圖所示:
注1:這裏的最大連結數表示同時能有幾個工程向授權伺服器申請授權注冊。
注2:若認證失敗,檢查防火牆設定,開放對應埠或者關閉防火牆。
3. 授權伺服器為 Linux 系統
3.1 下載 machine 工具
點選下載 machine 工具,用於獲取授權伺服器資訊檔案:
注:一般情況下,64 位的 Linux 用 amd64,32 位的 Linux 用 i386。
極少情況下(當物理機器使用的是 RISC 精簡指令集,低功耗 CPU)才使用 arm,具體跟使用硬體有關。
系統 | 獲取伺服器資訊檔案 |
---|---|
Linux_amd64 | |
Linux_arm32 | |
Linux_i386 | |
Linux_arm64 |
3.2 匯出授權伺服器資訊
注:本節操作必須要使用管理者帳號進行,否則會導致啟動授權過程報錯,機器碼不匹配。
以 Linux_amd64 為例:
將壓縮包上傳至授權伺服器,解壓生成 machine.file 檔案:
unzip linux_amd64.zip
為 machine.file 檔案新增權限:
chmod 777 machine
運作 machine.file 檔案,自動生成授權伺服器資訊檔案,即 require 目錄下的 MachineInfo.rif 檔案:
./machine
3.3 獲取授權檔案
請使用合同中指定的郵箱傳送注冊資訊給 FineBI 商務business@fanruan.com,郵件格式如下:
商務收到郵件,覈實無誤後會生成授權檔案FanruanLicenseServer.zip,以郵件方式傳送給使用者。
郵件內容如下表所示:
清單 | 内容 | 注意事項 | |
---|---|---|---|
優先聯絡 | 請提前聯絡帆軟銷售,應答相關事項並簽署合同 | - | |
發件人 | 請使用合同中指定的郵箱 | 如傳送注冊資訊的郵箱,非合同中指定的郵箱,則不予注冊 | |
收件人 | business@fanruan.com | - | |
標題 | XXX 公司注冊 FineBI 正式授權檔案 | 如傳送注冊資訊時,未註明公司名稱,則不予注冊 | |
正文 | 基礎資訊 | 公司名稱:XXX 公司 專案名稱:XXX 專案 合同簽定日期:XXXX年XX月XX日 | - |
注冊方式 | 私有云認證 | ||
FineBI 伺服器版本 | FineBI 工程的版本 | 如傳送注冊資訊時,未註明版本,則不予注冊 | |
FineBI 伺服器IP | 哪些 FineBI 伺服器的 IP允許被注冊,為 FineBI 伺服器的內網 IP 例如:192.168.100.25-192.168.100.26、192.168.0.1 | 如傳送注冊資訊時,未註明 FineBI 伺服器IP,則不予注冊 「FineBI 伺服器 IP 網段」範圍為:1.0.0.0-255.255.255.255 | |
FineBI 工程名 | 允許授權的工程名,例如:report1、report2 | 若不提供,表示對此項不進行限制 | |
授權伺服器域名 | 為授權伺服器的域名 不提供則要保證 FineBI 伺服器可以透過 IP 存取授權伺服器 格式:www.baidu.com、www.google.com | - | |
授權伺服器公網 IP | 若 FineBI 伺服器需要透過授權伺服器的公網 IP 存取,還需提供授權伺服器公網 IP | - | |
授權個數 | 一個授權伺服器可以同時給多個 FineBI 伺服器授權 這裏是限制同時注冊的 FineBI 伺服器的個數 | - | |
附件 | MachineInfo.rif | - |
3.4 啟動授權伺服器
注:如果是工具連結(xshell),在使用 nohup ./bin/server &命令行後,使用 exit 跳出登入。
重新登入後可使用 ps -ef|grep server 命令查看是否運作在後臺,若成功運作則表示私有云後臺啟動成功,只要伺服器不關機則會一直運作 。
1)在授權伺服器上,解壓商務傳送的授權檔案壓縮包 FanruanLicenseServer.zip
unzip FanruanLicenseServer.zip
2)解壓完成後,以管理者權限運作 bin 目錄下的 server
nohup ./server &
注:2021-10-13 及之後獲取的 server.exe 檔案,支援啟動認證伺服器的時候指定語言,預設簡體中文,額外提供英文。
啟動命令範例:./server -language en
3)啟動認證伺服器成功,如下圖所示:
3.5 BI 伺服器驗證授權
FineBI 工程部署在 FineBI 伺服器上,管理者登入數據決策系統,點選「管理系統>注冊資訊>版本資訊」,點選「立即注冊」。
認證方式選擇「私有云認證」,伺服器位址填寫上面授權伺服器顯示的 IP 和監聽埠,例如https://172.16.63.131:8081,點選「提交認證」,如下圖所示:
注1:若提供了授權伺服器域名,則填寫授權伺服器域名,若未提供授權伺服器域名,則填寫 IP 。
注2:請確定 FineBI 伺服器可以存取授權伺服器。
認證成功後,如下圖所示:
注1:這裏的最大連結數表示同時能有幾個工程向授權伺服器申請授權注冊。
注2:若認證失敗,檢查防火牆設定,開放對應埠或者關閉防火牆。
4. 授權伺服器為 Mac 系統
4.1 下載 machine 工具
點選下載 machine 工具,用於獲取授權伺服器資訊檔案:Mac.zip
4.2 匯出授權伺服器資訊
將壓縮包上傳至授權伺服器,解壓生成 machine.file 檔案:
unzip Mac.zip
為 machine.file 檔案新增權限:
chmod 777 machine
運作 machine.file 檔案,自動生成授權伺服器資訊檔案,即 require 目錄下的 MachineInfo.rif 檔案:
./machine
4.3 獲取授權檔案
請使用合同中指定的郵箱傳送注冊資訊給 FineBI 商務business@fanruan.com,郵件格式如下:
商務收到郵件,覈實無誤後會生成授權檔案FanruanLicenseServer.zip,以郵件方式傳送給使用者。
郵件內容如下表所示:
清單 | 内容 | 注意事項 | |
---|---|---|---|
優先聯絡 | 請提前聯絡帆軟銷售,應答相關事項並簽署合同 | - | |
發件人 | 請使用合同中指定的郵箱 | 如傳送注冊資訊的郵箱,非合同中指定的郵箱,則不予注冊 | |
收件人 | business@fanruan.com | - | |
標題 | XXX 公司注冊 FineBI 正式授權檔案 | 如傳送注冊資訊時,未註明公司名稱,則不予注冊 | |
正文 | 基礎資訊 | 公司名稱:XXX 公司 專案名稱:XXX 專案 合同簽定日期:XXXX年XX月XX日 | - |
注冊方式 | 私有云認證 | ||
FineBI 伺服器版本 | FineBI 工程的版本 | 如傳送注冊資訊時,未註明版本,則不予注冊 | |
FineBI 伺服器IP | 哪些 FineBI 伺服器的 IP允許被注冊,為 FineBI 伺服器的內網 IP 例如:192.168.100.25-192.168.100.26、192.168.0.1 | 如傳送注冊資訊時,未註明 FineBI 伺服器IP,則不予注冊 「FineBI 伺服器 IP 網段」範圍為:1.0.0.0-255.255.255.255 | |
FineBI 工程名 | 允許授權的工程名,例如:report1、report2 | 若不提供,表示對此項不進行限制 | |
授權伺服器域名 | 為授權伺服器的域名 不提供則要保證 FineBI 伺服器可以透過 IP 存取授權伺服器 格式:www.baidu.com、www.google.com | - | |
授權伺服器公網 IP | 若 FineBI 伺服器需要透過授權伺服器的公網 IP 存取,還需提供授權伺服器公網 IP | - | |
授權個數 | 一個授權伺服器可以同時給多個 FineBI 伺服器授權 這裏是限制同時注冊的 FineBI 伺服器的個數 | - | |
附件 | MachineInfo.rif | - |
4.4 啟動授權伺服器
注:授權伺服器上運作的可執行檔案不要關閉,即 Mac 下 server 不能關閉。
在授權伺服器上,解壓商務傳送的授權檔案壓縮包 FanruanLicenseServer.zip。
以管理者權限運作 bin 目錄下的 server ,如下圖所示:
注:2021-10-13 及之後獲取的 server.exe 檔案,支援啟動認證伺服器的時候指定語言,預設簡體中文,額外提供英文。
啟動命令範例:./server -language en
4.5 BI 伺服器驗證授權
FineBI 工程部署在 FineBI 伺服器上,管理者登入數據決策系統,點選「管理系統>注冊資訊>版本資訊」,點選「立即注冊」。
認證方式選擇「私有云認證」,伺服器位址填寫上面授權伺服器顯示的 IP 和監聽埠,例如https://172.16.63.131:8081,點選「提交認證」,如下圖所示:
注1:若提供了授權伺服器域名,則填寫授權伺服器域名,若未提供授權伺服器域名,則填寫 IP 。
注2:請確定 FineBI 伺服器可以存取授權伺服器。
認證成功後,如下圖所示:
注1:這裏的最大連結數表示同時能有幾個工程向授權伺服器申請授權注冊。
注2:若認證失敗,檢查防火牆設定,開放對應埠或者關閉防火牆。
5. 注冊失敗
5.1 現象描述
若注冊失敗,頁面將出現提示彈窗,如下圖所示:
5.2 失敗原因
點選詳細資訊即可查看注冊失敗的原因,根據具體失敗原因進行排查。
錯誤碼 | 錯誤名 | 含義 |
---|---|---|
10000 | JSON_PARSER_ERROR | 資料格式不正確 |
10001 | PARAM_INPUT_ERROR | 您輸入參數有誤 |
20000 | DO_NOT_NEED_DEACTIVATE | 該機器未授權無需解除綁定 |
30000 | LICENSE_EXPIRED | 憑證已過期 |
30001 | REPORT_VERSION_ERROR | 版本不匹配 |
30002 | ACCOUNT_STATUS_ERROR | 賬戶狀態不正常(解除綁定的時候出現該提示,說明這臺機器因未授權無需解除綁定) |
30003 | LICENSE_IP_ERROR | IP 不在允許的範圍之內 |
30004 | LICENSE_DOMAIN_ERROR | 域名不在允許的範圍之內 |
30005 | LICENSE_APPNAME_ERROR | 應用名不在允許的範圍之內 |
30007 | REGISTER_OUT_OF_LIMIT | 已達可授權數量上限 |
注:除上述外失敗原因外,其他統一報錯:憑證內容不正確。
有多個失敗原因時,平台中會全部顯示出來。
6. 遷移授權伺服器
6.1 銷燬授權
首先,銷燬當前認證伺服器。以管理者身分進入 bin 目錄,再運作。
6.1.1 Windows
在 Windows 中,開啟 cmd,切換到 bin 目錄下,運作命令如下所示:
.\server.exe -destroy
如下圖所示:
6.1.2 Mac 和 Linux
在 Mac 和 Linux中,運作命令如下所示:
./server -destroy
如下圖所示:
6.2 獲得銷燬證據檔案
執行銷燬命令後,會銷燬當前的伺服器認證允許,並生成一個銷燬資訊的證據檔案,如下圖所示:
注:在 Windows 中,有時候會報錯,得在與 bin 同級目錄建一個叫 uninstall 的資料夾,卸載檔案會在這個資料夾裏面出現。
6.3 重新注冊
客戶透過郵件傳送給商務下面兩個檔案:
receipt.fr 檔案和按照申請認證伺服器的步驟,重新生成MachineInfo.rif檔案。
商務收到receipt.fr檔案,驗證完成應答銷燬後,再給客戶傳送新的認證伺服器檔案。
注:銷燬授權伺服器後,若重啓 FineBI 伺服器則立即注冊失敗;若未重啓 FineBI 伺服器則在約 24 小時後注冊失敗。