1. 概述
1.1 版本
FineBI 版本 | 微信管理插件 | HTML5行動端展現插件 |
---|---|---|
6.0 | V11.0 | V11.0 |
1.2 功能簡介
安裝微信管理插件,可實現微信整合
在排程管理的匯出設定中,可以配置並推播微信訊息
支援整合多個應用
注:範例的是非私有化部署環境下的整合步驟。
1.3 注意事項
注意事項 1
BI伺服器一定是可以被外網存取的,並且一定是域名地址,不能用 IP 地址。域名地址舉例http://xxx.xxx.com:xxx/webroot/decision。如果是http://IP:xxx/webroot/decision,是不可以做微信整合的。
注意事項 2
BI 伺服器需要能存取外網,若 BI 伺服器在內網,無法存取到微信伺服器的話,需要進行正向代理配置,代理配置參考:微信釘釘整合環境準備 4.3 伺服器私有化部署
2. 前期準備
2.1 安裝插件
點選下載插件:微信管理、HTML5 行動端展現插件
插件安裝方法參照 插件管理
2.2 配置環境
1)不建議使用者在本地工程做企業微信整合,建議將 BI 工程部署到 tomcat 伺服器參見 tomcat伺服器部署 中,做企業微信整合。
2)在配置整合之前,必須先完成網路環境配置,參考文檔:微信釘釘整合環境準備
3. 建立應用
3.1 微信後台建立應用
1)管理者登入企業微信後,在「應用管理」Tab 下點選「建立應用」,如下圖所示:
2)上傳應用「 logo」,填寫「應用名稱」,「應用介紹」選填。設定「可見範圍」(必須是部門),設定完成後,點選「建立應用」。
注:若「可見範圍」不是部門而是單獨的微信使用者,那麼在平台「微信管理>成員管理」 下會看不到使用者資訊,因為右邊的組織機構是空的,而使用者是屬於部門的,所以也是空的。
對於單獨的微信使用者,建議先在企業微信通訊錄設定好標籤,再透過標籤的方式新增到FineReport中。
3.2 獲取應用參數
微信應用建立成功之後,需要關注兩個參數:
參數 | 含義 |
---|---|
CorpID | 企業 ID |
Secret | 授權碼 |
3.2.1 CorpID
點選我的企業,可查看企業ID,如下圖所示:
注:企業 logo 和簡稱可以修改。
3.2.2 Secret
1)點選「應用管理」,點選已建立的應用,如下圖所示:
2)點選可查看 Secret ,如下圖所示:
4. 平台微信管理
在 2.1 節安裝插件後,以管理者身分進入數據決策系統,點選「管理系統>微信管理」,如下圖所示:
4.1 應用管理
4.1.1 設定伺服器地址
必須設定「報表伺服器地址」並儲存如下圖所示。如果不設定,推播的時候可能會有問題,例如:http://域名:埠號/webroot/decision
注:請使用二級或二級以上域名,且需透過 ICP 備案。
4.1.2 建立企業微信應用
點選「建立微信應用」,輸入相應的「企業應用名稱」、和 3.2 節獲取的「CorpID」、「Secret」,點選確定,如下圖所示:
注:請填寫合乎規範的資訊,企業應用名稱、CorpID、Secret 不可為空,且應用名稱不可與其他應用的重複。
建立微信應用成功後,可對資訊進行修改和刪除,支援整合多個微信應用。如下圖所示:
4.2 應用快捷配置
4.2.1 微信代理跳轉
外網環境:
外網環境不需要設定代理伺服器地址。
內網環境:
若 BI 伺服器是配置在內網,則需要配置代理伺服器地址,來進行微信的存取。
1)先判斷報表伺服器上,ping qyapi.weixin.qq.com,能 ping 通,「微信管理>應用快捷配置>代理伺服器地址」不用填寫。
2)ping 不通,找一個代理伺服器配置 nginx 正向代理,代理配置如下:
server {
listen 8113; // 微信代理伺服器埠
server_name 10.2.2.3; //微信代理伺服器IP
location / {
proxy_redirect off;
proxy_pass https://qyapi.weixin.qq.com;//微信伺服器域名
}
location = /favicon.ico {
log_not_found off;
}
}
3)平台配置
正文框中輸入正確的「代理伺服器地址」,點選「測試連結並儲存」,當連結成功,提示「連結成功」如下圖所示:
注:當客戶需要配置正向代理時,可將對應代理伺服器的地址填寫在快捷配置這裏,具體正向代理的配置可以參考:微信釘釘整合環境準備第 4 節
4.2.2 主頁型應用快速配置
生成微信連結包含兩種方法:主頁型應用快速配置、生成微信連結
主頁型應用快速配置:
應用場景:
如果客戶這裏要用配置的主頁,是想要直接登入到 BI 平台,顯示行動端的目錄的話,只需要在上面點選微信「一鍵配置」,會自動把各個 url 都填寫上的,不需要使用者額外操作。
操作步驟:
1)選擇需要配置的「企業應用名稱」點選「一鍵配置」,即可快速的配置主頁型應用,不需要使用者再到微信後台配置。如下圖所示:
2)若配置前,微信應用的主頁連結和選單為空,「一鍵配置」後進入第 3 節建立的微信應用,「可信域名」、「應用主頁連結」、「自訂選單」中設定一個選單並新增主頁連結已設定完成。如下圖所示:
4.2.3 生成微信連結
可以生成兩種微信連結:一是用來單點登入到平台目錄的;二是用來單點登入到範本的。
生成連結的時候一定要選擇對應「企業應用名稱」。
應用場景:1)應用的 主頁 配置;2)排程管理最後一步「檔案處理>用戶端通知」推播「自訂連結」。可參考文檔:排程管理任務設定;
4.2.3.1 生成微信連結
1)生成存取決策平台的微信連結
選擇「企業應用名稱」,連結的頁面為「決策平台」,點選「生成連結」,點選「複製」,如下圖所示:
2)生成存取某個範本的微信連結
首先,選擇「企業應用名稱」,連結頁面選擇「單個範本」,然後,選擇要生成連結的儀表板或者範本,點選「生成連結」後「複製」。
單個範本可設定「BI儀表板」和「報表」:
單個範本選擇「BI儀表板」時:
①(只有選擇儀表板和製作儀表板的人都在同一部門,該情況才生效)若使用者分配到部門,可選擇到:部門內可管理使用者製作的儀表板、其他部門的使用者製作的儀表板、自己帳號下的儀表板;
②若使用者未分配到部門,跟隨排程管理的權限規則。
注 1:若沒有設定其他使用者的管理權限,則只能選擇自己的儀表板。
注 2:關於使用者部門管理可參考:使用者管理
單個範本選擇「報表」下範本時:操作步驟參考報表平台的 微信整合 4.2.3 節單個範本設定內容。
3)生成自訂連結
生成在微信能夠存取的輕應用連結。
首先,選擇「企業應用名稱」,生成「自訂連結」並填入「行動端輕應用」中生成的連結。然後點選「生成連結」並複製即可。如下圖所示:
4.2.3.2 設定應用主頁連結
進入第 3 節建立的微信應用,設定「應用主頁」,如下圖所示:
3)在「工作台應用主頁」中點選設定「網頁地址」,貼上 BI 平台中生成的微信連結,點選「確定」。如下圖所示:
4)在「自訂選單」中點選「設定」,填寫主選單,設定選單內容為跳轉到網頁,填寫地址(上面生成的微信連結貼上過來),點選儲存,如下圖所示:
點選發佈,如下圖所示:
5)在「網頁授權及JS-SDK」中點選設定可信域名,輸入可信域名,點選確定。如下圖所示:
4.2.4 申請域名校驗
1)開啟第 3 節建立的應用,在網頁授權及JS-SDK中點選申請校驗域名,點選下載檔案,下載校驗檔案。
2)把 txt 校驗檔案放在根目錄下。例如:%FineBI_HOME%/webapps/ROOT/ 。如果修改了伺服器根目錄的,就要做對應調整。
注:本地安裝部署的 BI 和部分獨立部署的工程本身沒有 ROOT 路徑。Tomcat 可以自行建立路徑。
本地安裝部署的自行建立也不生效,不建議本地部署的工程做整合。
3)勾選已上傳域名歸屬校驗檔案,點選確定,看到已啟動,說明域名校驗成功。如下圖所示:
範例中的可信域名為:secure.finedevelop.com:63777
4.2.5 建立微信群
使用者可使用應用建立微信群,自訂「微信群名稱」、「群主」和「群成員」,支援透過排程管理推播群訊息到微信群。
注:除群主外,群成員不可少於 2 人。
詳情請參見文檔:排程管理使用者端通知-APP通知
成功新增後如下圖所示:
4.3 成員管理
4.3.1 使用者匹配方式
可根據實際情況選擇一種使用者匹配方式。
使用者匹配方式:微信號匹配、手機帳號匹配、手動匹配、自訂匹配。「成員管理」頁面如下圖所示:
注:不管整合幾個微信應用,使用者統一進行管理。
微信號匹配:
微信號匹配和手機號碼匹配展示列相同。
微信號匹配,則是微信成員名與 BI 裏的帳號匹配,為一對一匹配。
手機號碼匹配,微信使用者的手機號碼是唯一的,但是 BI 使用者可以設定多個使用者有同一個手機號碼,此時的匹配邏輯為哪個報表使用者先建立則匹配哪個
選擇這兩個匹配方式時,微信通訊錄資訊展示:微信成員名、姓名、微信部門、微信成員手機號碼,如下圖所示:
注:這些匹配的使用者資訊並不會存到某張表裏。
手動匹配:
當匹配方式為手動匹配時,微信成員列表中多出「報表帳號」一欄資訊,點選出現下拉框,選擇相應的報表帳號,進行手動匹配。如下圖所示:
注1:手動匹配時,BI 帳號支援選擇「不選」選項。
注2:手動匹配方式是使用者可以自由選擇與微信使用者匹配的 BI 使用者,可實現多個微信使用者匹配同一個 BI 使用者。
自訂匹配:
即透過設定的伺服器資料集,將對應資料列的微信使用者和報表使用者相匹配。若出現一個微信使用者對應了多個報表使用者的情況,預設匹配第一個報表使用者
選擇自訂匹配時,下方多出「匹配設定」項,選擇資料集、微信帳號及報表帳號,進行匹配。如下圖所示:
注:自訂匹配時,微信使用者列填寫的是微信帳號。
4.3.2 通訊錄更新
點選左側「立即更新」按鈕,立即更新通訊錄內容。也可設定定時更新。
點選「設定自動更新」按鈕,彈出設定框,設定更新頻率。
注1:使用者匹配方式為「微信號匹配」或「手機號碼匹配」時,如果使用者增刪改 BI 使用者或者在後台增刪改微信使用者,需要手動同步通訊錄更新。
注2:使用者匹配方式為「手動匹配」或「自訂匹配」時,如果使用者增刪改 BI 使用者或者在後台增刪改微信使用者,無需更新同步。
5. 效果查看
完成整合後,使用者即可在微信的 PC 端或行動端查看 FineBI 工程和儀表板了。
5.1 企業微信
進入企業微信,點選工作台,點選FineBI 微信整合,該使用者會看到自己權限內可以查看的目錄,如下圖所示:
5.2 個人微信
上面描述為在企業微信中的效果。
普通微信可以掃描QRCODE關注,在普通微信中即可出現一個企業號,可在企業號中查看主頁內容或收到推播訊息。
1)在「通訊錄」 ,點選微信邀請,邀請關注,掃描QRCODE,即可加入此企業。如下圖所示:
2)進入企業後,點選建立的應用「應用主頁」,設定看到的內容與是否勾選在「微信插件中始終進入主頁有關」,如下圖所示:
若勾選「在微信插件中始終進入主頁」,收不到推播訊息。
若不勾選「在微信插件中始終進入主頁」,同時需要在「企業微信我>設定>新訊息通知」裏關閉「僅在企業微信中接受訊息」,個人微信可收到推播訊息,可以查看推播的內容和配置的自訂選單,如下圖所示:
6. 推播微信訊息
1)參考排程管理使用者端通知-APP通知 ,「檔案處理」步驟中選擇微信通知即可,如下圖所示:
2)企業微信使用者登入企業微信,可收到訊息。如下圖所示:
注:釘釘推播訊息內容支援顯示圖片訊息、檔案訊息,設定步驟詳細可參考 微信釘釘推播支援其他訊息類型
7. 注意事項
7.1 內網開放白名單
在做微信整合時,有的客戶為內網環境,不允許所有網頁都能存取,但要確定能存取微信的域名:https://qyapi.weixin.qq.com
7.2 企業微信 PC 端還是行動端效果
使用者希望做了企業微信整合後,在使用 PC 端企業微信時,可以展示 PC 端效果,而不是行動端。
但是現有的方法整合後,PC 端使用時就是行動端效果,那麼如何實現 PC端效果呢?
只需要修改下企業微信後台設定的連結,將 mobile 相關參數去掉即可,位置如下圖所示:
7.3 網路異常
1)問題描述
企業微信整合在平台建立微信應用時,如下圖所示:
新增的 CorpID 等資訊,一直報錯:網路異常,請檢查網路配置或 access_token 為空,corpId 和 secret 設定錯誤,如下圖所示:
2)解決方案
如果內網伺服器存取外網正常,需要檢查下報表平台的埠是不是被防火牆禁掉了,埠被禁就不能存取外網了。下面給出解決方案:
先在代理伺服器上面向報表伺服器開一個埠。
nginx 代理配置檔案中配置正向代理。
平台上配置代理伺服器地址,走通網路以後,新增應用正常,問題解決。
7.4 微信掃碼登入報錯
問題現象:
企業微信掃碼登入,部分成員掃碼後會報錯,檢查了該帳號,和企業微信名稱一樣;掃碼出錯的和正常的使用者在權限配置上是一樣的。
問題原因:
使用者在平台沒有綁定手機號碼。
解決方案:
1)可以先登入平台進行綁定手機號碼;
2)或者在同步使用者時(或者手動新增使用者時)新增上手機號碼,即也要維護手機號碼資訊。
7.5 微信單點登入慢
問題現象:
微信單點從點選應用到顯示目錄,需要 3s 的時間。本地一般也是需要 3-4s 。
問題原因:
單點速度除了受網路、手機效能影響外,還受到資料傳輸和頁面載入的 js 的影響。載入 H5 頁面有如下幾個耗時點:一是請求 js 資源,一個一般是 1 到 2 秒,然後瀏覽器把資源載入到記憶體,大概 200 毫秒,最後再把圖形渲染出來也需要一些時間,導致頁面載入緩慢。
8. 微信整合問題處理
1)環境是否配置好:微信釘釘整合環境準備
2)使用工具排查出現的各類常見(單點登入失敗、同步通訊錄失敗、訊息推播失敗)問題:微信釘釘除錯工具、微信釘釘推播/單點/同步失敗透過日誌定位
3)「微信管理」頁面的「應用管理」報錯;排程管理訊息推播報錯;網路異常等:微信釘釘應用列表報錯
4)出現錯誤碼,對照錯誤碼找問題:微信釘釘錯誤碼對照表