反饋已提交

網絡繁忙

微信整合

1. 概述

1.1 版本

使用企業微信,需要報表伺服器、H5、微信插件版本均匹配才能整合,版本的對應情況如下表所示:

報表伺服器版本

微信管理插件版本

功能變動
11.0.2V11.0.54微信管理支援將企業微信使用者同步到「使用者管理」,參考本文第 4.3.3 節
11.0.3
V11.0.62
  • 「應用快捷配置>生成微信連結」支援,生成自訂連結,詳情參見本文 4.2.3 節

  • 「成員管理」支援同步多個企業的資料

11.0.9
V11.0.74優化單點登入效能
11.0.27V11.0.92

成員管理>使用者匹配方式支援「信箱匹配」,詳情參見本文 4.3.1 節

1.2 功能簡介

  • 安裝微信管理插件,可實現微信整合

  • 在排程管理的匯出設定中,可以配置並推播微信訊息

  • 支援整合多個應用

1.3 注意事項

注意事項 1 

報表伺服器一定是可以被外網存取的,並且一定是域名地址,不能用 IP 地址。

域名地址舉例 http://xxx.xxx.com:xxx/webroot/decision 。

如果是http://IP:xxx/webroot/decision,是不可以做微信整合的。

注意事項 2 

報表伺服器需要能存取微信伺服器。

若報表伺服器在內網,無法存取到微信伺服器的話,支援正向代理配置,代理配置參考:行動端整合環境準備 。

注意事項 3 

微信整合下若使用「掃碼元件」、「檔案元件」, 則要求單點登入、且域名必須經過校驗。

校驗方法請參考:「微信整合」檔案元件&正文元件掃碼無法使用 。

2. 環境準備

2.1 安裝插件

點選下載插件:微信管理HTML5 行動端展現插件

設計器插件安裝方法請參見:設計器插件管理

伺服器安裝插件方法請參見:伺服器插件管理

注:微信/釘釘整合程式中,必須確定各版本相對應,詳情參見:微信、釘釘、H5、伺服器、JAR 之間的依賴關係

2.2 配置網路環境

在微信整合之前,必須先完成網路環境配置,參考文檔:行動端整合環境準備 。

3. 建立應用

3.1 微信後台建立應用

1)管理者登入企業微信後,在「應用管理」Tab 下點選「建立應用」,如下圖所示:

Ai图片翻译20240603101436图片翻译1721787276.png

2)上傳應用 logo,填寫「應用名稱」,「應用介紹」選填,設定「可見範圍」,設定完成後,點選「建立應用」,如下圖所示:

1721292698529.png

若「可見範圍」不是部門而是單獨的微信使用者,那麼在平台「微信管理」的「成員管理」 Tab下會看不到使用者資訊,因為右邊的組織機構是空的,而使用者是屬於部門的,所以也是空的。對於單獨的微信使用者,建議先在企業微信通訊錄設定好標籤,再透過標籤的方式新增到FineReport中。

3.2 配置可信IP和域名

由於企業微信針對自建及代開發應用進行安全性升級,2022 年 6 月 20 日之後建立的新應用,都必須先配置可信IP和可信域名。

詳情可參見:關於企業微信自建應用安全性升級的說明 。

登入企業微信後台,選擇「應用管理」,選擇對應的應用,設定「企業可信IP」。如果客戶遇到新增 IP,提示是第三方服務商IP(實際不是),需要找企業微信客服驗證一下企業可信IP,如下圖所示:

1721293063836388.png

3.3 獲取微信應用參數

微信應用建立成功之後,需要關注兩個參數:

  參數 含義 
  CorpID  企業 ID
  Secret   授權碼

3.3.1 CorpID

點選「我的企業」,可查看「企業ID」

注:企業 logo 和簡稱可以修改。

3.3.2 Secret 

1)點選「應用管理」,點選已建立的應用。

2)可查看 Secret ,如下圖所示:

1721293645030.png


4. 平台微信管理

以管理者身分進入數據決策系統,點選「管理系統」>「微信管理」,如下圖所示:

20240718171054.png

4.1 應用管理

4.1.1 報表伺服器地址

必須設定「報表伺服器地址」並儲存,如果不設定,推播的時候可能會有問題,報表伺服器地址範例:

http://域名:埠號/webroot/decision

注:請使用二級或二級以上域名,且需透過 ICP 備案。

輸入「報表伺服器地址」,如下圖所示:

QQ图片20240718171249.png

4.1.2 建立微信應用

點選「建立微信應用」,輸入相應的企業應用名稱CorpIDSecret,點選「確定」,如下圖所示:

QQ图片20240718171430.png

注:請填寫合乎規範的資訊,企業應用名稱、CorpID、Secret 不可為空,且應用名稱不可與其他應用的重複。

建立微信應用成功後,可對資訊進行修改和刪除,支援整合多個微信應用。如下圖所示:

20240718171625.png

4.2 應用快捷配置

4.2.1 微信代理跳轉

注1:若報表伺服器配置在外網環境中,則不需要設定代理伺服器地址。

若伺服器是配置在內網,存取不到微信伺服器,存取不到外網的時候需要配置「代理伺服器地址」。

若伺服器是配置在內網,且客戶伺服器和外網能互相存取到,網路正常,則「微信管理>應用快捷配置>代理伺服器地址」,不需要填寫。

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)平台配置如下圖所示:

QQ图片20240718171918.png

正文框中輸入正確的「代理伺服器地址」,點選「測試連結」,提示「連結成功」並「儲存」。

如需要詳細瞭解工程的網路環境要求,網路檢查方法,以及對應的不同情況下的代理配置,請參考:行動端整合環境準備

4.2.2 主頁型應用快速配置

功能簡介:

該功能即對微信主頁應用進行快速配置,配置的內容包括:可信域名、應用主頁連結、自訂選單中設定一個選單並新增主頁連結。

應用場景:

如果客戶這裏要用配置的主頁,是想要直接登入到平台,顯示行動端的目錄的話,只需要在上面點選微信「一鍵配置」,會自動把各個 url 都填寫上的,不需要使用者額外操作。

操作步驟:

預設為企業微信列表中的第一個,透過下拉框選擇需要配置的企業應用名稱,然後點選「一鍵配置」即可快速的配置主頁型應用,不需要使用者再到微信後台配置。如下圖所示:

QQ图片20240718172152.png

若配置前,微信應用的主頁連結和選單為空,點選「一鍵配置」按鈕後,直接進行快速配置。進入微信應用,可信域名應用主頁連結自訂選單中設定一個選單並新增主頁連結已設定完成


4.2.3 生成微信連結

  • 生成連結的時候一定要選擇對應企業應用名稱。

  • 可以生成兩種微信連結:一是用來單點登入到平台目錄的;二是用來單點登入到範本的。

注:使用 V11.0.74 插件生成的單點連結,若回退插件,需使用老版本插件重新生成連結配置主頁。

  • 應用場景:應用的 主頁 配置;

    排程管理最後一步「檔案處理>用戶端通知」推播「自訂連結」。可參考文檔:排程管理任務設定

    範本訊息事件插件推播。 範本訊息事件 可以將該連結推播給行動端使用者,使用者點開後即可存取連結對應的內容。

4.2.3.1 生成微信連結

1)生成存取決策平台的微信連結

首先要選擇「企業應用名稱」,連結頁面下拉選擇「決策平台」,點選「生成連結」後,點選「複製」按鈕即可。如下圖所示:

QQ图片20240718172618.png


2)生成存取某個範本的微信連結

首先要選擇「企業應用名稱」,連結頁面下拉選擇「單個範本」,然後選擇一張範本,如果需要設定參數,可以點選「設定參數預設值」進行設定,設定了參數後點選「解析參數值」,最後點選「生成連結」,點選「複製」按鈕即可,如下圖所示:

QQ图片20240718172803.png


3)生成自訂連結

生成在微信能夠存取的輕應用連結。

首先,選擇「企業應用名稱」,生成「自訂連結」並填入「行動端輕應用」中生成的連結。然後點選「生成連結」並複製即可。如下圖所示:

QQ图片20240718173145.png


4.2.3.2 生成應用主頁連結

如果只想主頁那邊掛一個範本,且支援單點登入開啟範本,不僅需要在這裏生成對應範本連結。

還需將生成的連結貼上到微信工作台或者自訂選單裏。在「網頁授權及JS-SDK」下設定可信域名/申請域名校驗(域名例如:demo.fanruan.com,步驟請參考:「微信整合」檔案元件&正文元件掃碼無法使用)。

注:設定可信域名就是說的你的微應用地址是可用的、合法的。

1)設定「應用主頁」。在「工作台應用主頁」中點選設定「網頁地址」,貼上平台中生成的微信連結,點選「確定」。

1721295699693750.png

2)在「自訂選單」中點選「設定」,填寫主選單,設定選單內容為跳轉到網頁,填寫地址(上面生成的微信連結貼上過來),點選「儲存」並「發佈」。

1721351450387372.png

3)在「網頁授權及JS-SDK」中點選設定可信域名,輸入可信域名,點選確定。

注:設定可信域名就是說的你的微應用地址是可用的、合法的。

1721351610757622.png

下面介紹下如何配置參數,如果想要使用「設定參數預設值」功能需要將插件更新到 V10.4.76 版本,如果想要使用「解析參數值」功能需要更新到 V10.4.97 版本。

  • 設定參數預設值

點選「設定參數預設值」後,如果範本本身有參數,那麼會顯示在下方,使用者可以設定參數的預設值,當然也可以點選右上角新增參數,如下圖所示:

注:如果想刪除參數,可以滑鼠懸浮在參數列表的右邊,會出現刪除按鈕。

2024-07-19_09-14-39.png

  • 解析參數值

假如一張範本「a.cpt」設定了一個參數「date」,其值為公式${today}

  1. 如果勾選了「解析參數值」,那麼點選「生成連結」後,連結中會自動解析出今天的日期,也就是變成了:a.cpt&date=2020-11-03。點開範本會自動顯示今天的資料資訊(2020-11-03)。

  2. 如果不想連結中直接解析參數,想要保留這個公式,可以取消勾選「解析參數值」,點選「生成連結」後,公式保留:a.cpt&date=${today}

2024-07-19_09-16-05.png

注1:微信/釘釘整合連結必須勾選解析參數值,否則將導致參數丟失。

注2:範本訊息推播的訊息連結可選擇不解析參數值,進而實現推播的公式計算。

4.2.4 申請域名校驗

步驟請參考文檔:「微信整合」檔案元件&正文元件掃碼無法使用

4.2.5 建立微信群

JAR 包在 2020-07-08 及之後,且企業微信管理插件在 V10.4.80 及之後的版本,新增微信群設定。

使用者可使用應用建立微信群,自訂微信群名稱、群主和群成員,支援透過排程管理推播群訊息到微信群。

詳情請參見:企業微信定時推播訊息

QQ图片20240719091812.png

4.3 成員管理

4.3.1 使用者匹配方式

可根據實際情況選擇一種使用者匹配方式。

使用者匹配方式:微信號匹配、手機帳號匹配、手動匹配、自訂匹配、信箱匹配。「成員管理」頁面如下圖所示:

注1:不管整合幾個微信應用,使用者統一進行管理。

注2:企業微信安全策略升級,企業微信在userId換取使用者資訊的API中,不再傳回手機號碼碼。

         因此2022-06-20之後建立的應用不推薦使用手機號碼匹配,可以使用微信號匹配等其他匹配方式的功能,但老的應用不受影響。

注3:切換了匹配方式後,都需要同步一下使用者.。

QQ图片20240719092023.png

1)微信號/手機帳號/信箱匹配

微信號匹配、手機帳號匹配 和 信箱匹配 展示列及匹配規則相同。

  • 微信號匹配,則是微信成員名與報表裏帳號匹配,為一對一匹配。

  • 手機帳號匹配,微信使用者的手機號碼是唯一的,但是報表使用者可以設定多個使用者有同一個手機號碼,此時的匹配邏輯為匹配使用者儲存表中按順序查到的第一個報表使用者 。

  • 信箱匹配,由於報表使用者可以設定多個使用者有同一個信箱(企業微信的email欄位),此時的匹配邏輯為匹配使用者儲存表中按順序查到的第一個報表使用者 。

注:建議保證使用者一對一的匹配關係。

選擇這三個匹配方式時,微信通訊錄資訊展示:姓名、微信成員名、微信部門、微信成員手機號碼 和 微信成員信箱。如下圖所示:

Ai图片翻译2024060592246图片翻译1721352166.png

注:這些匹配的使用者資訊並不會存到某張表裏。

2)手動匹配

當匹配方式為「手動匹配」時,微信通訊錄資訊展示:姓名、帳號、微信成員名、微信部門、微信成員手機號碼。如下圖所示:

列表中多出「報表帳號」一欄資訊,點選出現下拉框,選擇相應的報表帳號,進行手動匹配。如下圖所示:

注1:手動匹配時,報表帳號支援選擇「不選」選項。

注2:手動匹配方式是使用者可以自由選擇與微信使用者匹配的報表使用者,可實現多個微信使用者匹配同一個報表使用者。


Ai图片翻译2024060592423图片翻译1721352262.png

3)自訂匹配

即透過設定的「伺服器資料集」,將對應資料列的微信使用者和報表使用者相匹配。

若出現一個微信使用者對應了多個報表使用者的情況,預設匹配查到的第一個報表使用者。

選擇自訂匹配時,下方多出「匹配設定」項,選擇「資料集」、「微信帳號」及「報表帳號」,進行匹配。如下圖所示:

注:自訂匹配時,微信使用者列填寫的是微信帳號。

Ai图片翻译2024060592714图片翻译1721352434.png

4.3.2 微信通訊錄

點選左側「立即更新」按鈕,立即更新通訊錄內容。也可設定定時更新,點選「自動更新」按鈕,彈出設定框,設定更新頻率。如下圖所示:

注1:使用者匹配方式為「微信號/手機帳號/信箱匹配」時,如果使用者增刪改報表使用者或者在後台增刪改微信使用者,需要手動同步通訊錄更新。

注2:使用者匹配方式為「手動/自訂匹配」時,如果使用者增刪改報表使用者或者在後台增刪改微信使用者,無需更新同步。

QQ图片20240719092844.png

4.3.3 使用者同步

報表版本 V11.0.2 ,微信管理插件版本 V11.0.54 之後,支援將企業微信通訊錄的使用者資訊同步到「使用者管理」介面中,儲存到平台。

使用者同步配置詳情請參見:同步使用者

注:微信使用者的同步只是拿到微信使用者資訊表,為了後續跟報表使用者表進行匹配關係的建立,微信使用者的同步操作不會改寫現有報表平台使用者。

1)同步配置

在「使用者管理」中進行「同步使用者」,使用者來源選擇「從企業微信同步」,選中對應的微信應用,即可根據企業微信通訊錄實現同步效果。

注:「微信管理>成員管理」的通訊錄手動更新和自動更新;「使用者管理>同步使用者」都能實現平台使用者資訊的更新。

QQ图片20240719093149.png

2)同步成功後,使用者資訊同步到平台。

注:因為企業微信API限制,所以無法同步密碼,報表使用者初始密碼隨機生成。如果使用者在 APP 或 PC 端想透過帳號密碼登入,需點選 忘記密碼 ,重置後才能登入。

同步出現問題請參見:同步/匯入使用者常見問題

1721352882973159.png

3)同步觸發方式

同步類別同步設定方式詳情
手動同步使用者管理>同步使用者>從企業微信同步
第一次同步企業微信使用者資訊
使用者管理>同步使用者管理>立即同步對使用者資訊再次進行同步
微信管理>成員管理>立即更新更新通訊錄,並同步「使用者管理」中的使用者資訊
自動同步
微信管理>成員管理>自動更新
根據微信管理中設定的「自動更新」時間,自動更新通訊錄,並同步「使用者管理」中的使用者資訊

注意事項:

1)企業微信通訊錄新增的使用者,要保證姓名、帳號、部門、手機號碼不為空;

2)使用企業微信同步前,平台同步功能是開啟的,且不能清空過同步資料;

不滿足以上兩點,同步企業微信使用者到平台會失敗

3)企業微信和平台同步欄位的映射關係

將企業微信中的成員資訊,同步到「使用者管理」中時,每條欄位的映射關係。

平台欄位企業微信欄位
使用者ID
帳號
帳號帳號
姓名姓名
密碼

因為企業微信API限制,無法同步密碼,所以初始密碼隨機生成;

如果使用者希望透過 APP 或 PC 端登入,需要 重置密碼

手機手機
信箱信箱
部門iddepartmentid
部門名稱部門
無職務無職務
角色id
tagid
角色名稱標籤

5. 效果查看

5.1 企業微信

進入企業微信,點選「工作台」,點選「FineReport 微信整合」,該使用者會看到自己權限內可以查看的目錄,如下圖所示:

注:不建議在電腦版企業微信存取行動端範本。

1721353126551045.png

5.2 個人微信

普通微信可以掃描QRCODE關注,在普通微信中即可出現一個企業號,可在企業號中查看主頁內容或收到推播訊息。

1)在「通訊錄」 Tab 頁下點選「微工作台」,點選「微信邀請」,邀請關注,掃描QRCODE,即可加入此企業。如下圖所示:

1721353239824859.png

2)進入企業後,點選應用,看到的內容與是否勾選「在微信插件中始終進入主頁」有關,如下圖所示:

1721353368253068.png


  • 若勾選在微信插件中始終進入主頁,收不到推播訊息。

  • 若不勾選「在微信插件中始終進入主頁」,同時需要在「企業微信」>「我」>「設定」>「新訊息通知」裏關閉「僅在企業微信中接受訊息」,則可收到推播訊息,可以查看推播的內容和配置的自訂選單,如下圖所示:

1721353468585082.png

6. 微信單點登入及權限控制

6.1 單點登入

在手機企業微信 App 裏,您可以看到是不需要登入 FS,直接可以查看結果的。而如果您使用手機瀏覽器存取相同的報表,您會發現,是需要登入的。那是因為,將微信成員與報表使用者聯動後,透過微信企業應用進入查看報表時,在 FineReport 後台,我們會使用微信的 OAuth2.0 API進行使用者驗證並獲取對應微信成員名,然後聯動報表使用者並自動登入,進而實現微信單點登入。

6.2 權限控制

微信應用的選單是在微信中管理,所以哪些成員可以看到的哪些報表這是在微信中控制。比如您可以建立多個報表應用,每個應用的查看權限選擇不同的成員或組。

使用者在微信中開啟報表,是否可以查看報表的內容,以及可以查看的資料這部分是在 FR 報表端控制的,控制方法與 PC 端是一樣的,比如可以透過角色控制可查看的報表,可以在報表範本中透過 SQL 語句透過帳號過濾來實現不同使用者看到的資料不同等等。

7. 注意事項

7.1 內網開放白名單

在做微信整合時,有的客戶為內網環境,不允許所有網頁都能存取,但要確定對 qyapi.weixin.qq.com  這個域名開放存取權限。

7.2 微信掃碼登入報錯

問題現象:

企業微信掃碼登入,部分成員掃碼後會報錯,檢查了該帳號,和企業微信名稱一樣;掃碼出錯的和正常的使用者在權限配置上是一樣的。

2024-07-19_09-45-21.png

問題原因:

使用者在平台沒有綁定手機號碼。

解決方案:

1)可以先登入平台進行綁定手機號碼;

2)或者在同步使用者時(或者手動新增使用者時)新增上手機號碼,即也要維護手機號碼資訊。

7.3 微信單點登入慢

問題現象:

微信單點從點選應用到顯示目錄,需要 3s 的時間。本地一般也是需要 3-4s 。

問題原因:

單點速度除了受網路、手機效能影響外,還受到資料傳輸和頁面載入的 js 的影響。載入 H5 頁面有如下幾個耗時點:一是請求 js 資源,一個一般是 1 到 2 秒,然後瀏覽器把資源載入到記憶體,大概 200 毫秒,最後再把圖形渲染出來也需要一些時間,導致頁面載入緩慢。

7.4 23001網路異常

微信部署代理伺服器時,插件日誌出現 error 級別的日誌報錯,報錯碼為「23001」則是網路異常的問題。

可以參考文檔解決異常:代理伺服器連結外網 3.1節。

8. 微信整合問題處理

1)環境是否配置好:行動端整合環境準備

2)使用工具排查出現的各類常見(單點登入失敗、同步通訊錄失敗、訊息推播失敗)問題:微信釘釘除錯工具微信釘釘推播/單點/同步失敗透過日誌定位

3)「微信管理」頁面的「應用管理」報錯;排程管理訊息推播報錯;網路異常等:微信釘釘應用列表報錯

4)出現錯誤碼,對照錯誤碼找問題:微信釘釘錯誤碼對照表


附件列表


主題: 行動端應用
  • 有幫助
  • 沒幫助
  • 只是瀏覽
  • 圖片不清晰
  • 用語看不懂
  • 功能說明看不懂
  • 操作說明太簡單
  • 內容有錯誤
中文(繁體)

滑鼠選中內容,快速回饋問題

滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

不再提示

10s後關閉

獲取幫助
線上支援
獲取專業技術支援,快速幫助您解決問題
工作日9:00-12:00,13:30-17:30在线
頁面反饋
針對當前網頁的建議、問題反饋
售前咨詢
業務咨詢
電話:0933-790886或 0989-092892
郵箱:taiwan@fanruan.com
頁面反饋
*問題分類
不能為空
問題描述
0/1000
不能為空

反馈已提交

网络繁忙