企业微信完全集成方案
1. 企业微信完全集成方案概述
企业微信,是腾讯微信团队为企业打造的专业办公管理工具。观远数据支持与企业微信的深度集成,通过企业微信后台与观远数据管理中心的简单操作,即可进行集成,打通两个平台的账号体系,进行便捷操作。
2. 企业微信完全集成价值
观远数据与企业微信集成后可实现:
-
观远平台成为企业微信的内嵌应用;
-
从企业微信的应用里访问观远并且免密登录(包括企业微信的移动端和PC端);
-
Web端可用企业微信扫码登录;
-
订阅和预警消息推送至企业微信,一键触达。
3. 集成配置步骤
3.1 “企业微信后台”创建观远BI应用
企业微信管理后台地址:https://work.weixin.qq.com/wework_admin/frame#apps。
应用创建路径:企业微信PC端应用管理中心->应用->创建应用。
点击后,填写相关信息即可。
创建完毕后,可获取CorpId、AgentId和Secret,用于随后在观远管理后台进行配置。
CorpId的获取入口:我的企业—企业信息,此页面最底部“企业ID”栏。
AgentId与Secret的获取入口:应用管理-应用详情页。
3.2 “观远管理后台”填写企业微信应用相关信息
a.配置入口:管理中心—>系统集成—>企业微信配置。
b.填写信息:CorpId、AgentId和Secret(获取入口如3.1所述)。
此外,还支持配置需要拉取的用户与子部门对应的大部门ID。该功能可以满足部门级别采购BI产品时,只需要获取企业微信里部门级别的用户与子部门信息的需求。
c.填写后,需要"启用",才能正常进行企业微信消息推送和免密/扫码登录。
d.同时可获取回调域名以及应用主页链接,用于下一步在企业微信后台进行微应用配置。
回调地址可从观远管理后台直接获取。私有化环境下,回调域名地址可在 管理中心->系统管理->高级设置->域名设置 中进行配置,域名的初始状态是http://localhost:3001/,需要改成企业实际域名。
3.3 “企业微信后台”在观远BI应用中完成授权配置
点击应用,进入应用的设置页面。
如果不需要免密登录和扫码登录,则只需要配置"工作台应用主页"即可;如果需要免密登录和扫码登录,则需要指定配置。
3.3.1 工作台应用主页
填写点击应用后跳转的链接。
特别注意:
如需要免密/扫码登录,则此处链接需按照企业微信的要求加上相关参数。(可从观远管理后台直接获取,获取入口即上一步截图中的“应用主页”,一键复制即可。)
自行拼接链接的格式如下,其中需要替换的参数有4个,其他复制即可:
详情请参考《配置链接》
(1)替换参数说明(替换时不保留< >):
< corpid >,企业的corpid。
< host_url >,授权后重定向的回调链接地址(要带http、https)。
< domain_id >,即域名。私有化部署情况下,该参数也可做缺省处理(即 %26domain%3D这一串可缺省)。
< agentid >,即当前企业微信应用的ID。
特别说明:如果需要免密登录到表单里,则需要在配置的链接里,host_url后加一个固定的路由(如下),再按照第三方集成要求添加其他参数,之后整体链接需做URL编码转义,再贴入< host_url >。
例如:
原链接:https://app.mayidata.com/?path_url=survey-engine
URL编码后:https%3A%2F%2Fapp.mayidata.com%2F%3Fpath_url%3Dsurvey-engine
则< domain_id >=https%3A%2F%2Fapp.mayidata.com%2F%3Fpath_url%3Dsurvey-engine
(2)如不需要免密/扫码登录,则直接填写企业的观远BI登录地址即可。(此处网址需要必须带http或https)
3.3.2 网页授权及JS-SDK
填写可信域名,一般填写企业的观远BI登录地址即可。(可从观远管理后台直接获取,获取入口如3.2所述。)
此域名需与《3.3.3企业微信授权登录》和《3.4 “观远管理后台”用户属性中关联企业微信账号-注2》中的授权回调域、回调域名保持三域名一致。
注1.网址不能带http、https等,会标红提示,无法保存。
注2.因企业微信可信域名需校验域名与主体对应关系,配置可信域名如报错如下,需检查此处填写的域名是否为本企业或关联企业的域名,如为分析云客户,可联系运维更改BI系统域名为其公司域名。
注3:如果出现域名主体校验未通过,用户需点击“申请校验域名”,然后将系统生成的txt文件发给技术支持。
用户发送文件方式:将文件发生至售后群里并@群主即可。
如为本企业域名,则需完成域名企业主体认证,配置入口如下,配置方法见https://open.work.weixin.qq.com/help2/pc/15023?person_id=1;
如为关联企业域名,则需联系企业微信侧完成关联企业认证。
企业微信的关联企业认证说明文档:
https://open.work.weixin.qq.com/wwopen/common/readDocument/40754
3.3.3 企业微信授权登录
点击后,在Web网页一项中,填写回调地址。(可从观远管理后台直接获取,获取入口如2所述。)
注意:此处网址不能带http或https。
此域名需与《3.3.2 网页授权及JS-SDK》和《3.4 观远管理后台中关联企业微信账户-注2》中的可信域名、回调域名保持三域名一致。
报错详见 你暂无权限登陆此应用,可联系公司管理员
报错详见 no allow to access from your ip
3.3.4 配置可信IP
需配置BI的服务器IP为可信IP,支持添加多个,以英文分号;分隔。
3.4 “观远管理后台”用户属性中关联企业微信账号
企业微信配置“启用”后,系统会自动添加2个用户基础属性:“企业微信账号”和“企业微信公司名称”。
管理员可以给单个用户添加,也可以在“用户基础属性”设置中批量修改配置。
注1:企业微信账号不是个人微信号,也不是企业微信名称,而是企业微信里的ID。用户的企业微信账号查看入口:
(1)企业微信管理后台—通讯录—点击某个用户。
(2)企业微信管理后台—通讯录—批量导出。
注2:
-
每个用户属性里必须补充“企业微信公司名称”信息,否则无法正常使用企业微信免密登录、扫码登录和接收订阅消息。
-
“企业微信公司名称”这个属性配置值,只能下拉选择,选项是企业微信配置时填写的子公司名称。
-
此域名需与《3.3.2 网页授权及JS-SDK》和《3.3.3 企业微信授权登录》中的可信域名、授权回调域保持三域名一致。
4. 效果演示
(1)PC端登录页面出现企业微信登录入口,点击后可扫码登录。
注:如果您的企业配置了多个企业微信公司的应用,则此处点击扫码登录后,需要先选择对应的子公司,得到对应子公司的二维码才能正常扫码登录。
(2)企业微信手机APP端——工作台中,可看到创建的应用,点击进入即可免密登录到观远平台H5界面。
(3)企业微信PC端应用中,在OA工作台可以看到观远平台应用入口,点击后可免密登录到观远平台。
(4)订阅、预警消息推送至企业微信。在配置订阅、预警通知渠道时,可以选择“企业微信”作为触达方式。
其他补充信息:
-
企业微信免密/扫码登录、消息推送的集成适用于私有化部署客户
-
SaaS客户(app.guandata.com) 由于企业微信的服务主体域名管控机制(2022年初上线),无法完成深度集成。
-
SaaS客户可以做企业微信内嵌应用的简单集成,通过记住密码来实现快捷登录。
-
私有化部署集成企业微信时,请确保观远服务器与企业微信服务器的网络连通。
-
如果配置了多个公司的企业微信应用,且某个客户已经设置过企业微信公司名称,后又修改企业微信公司名称,需要对原有用户的属性值做更新。
举例:原来公司名叫AA,且把小张的“企业微信公司名称”属性值设置为AA。后来在企业微信配置处,把公司名称改为BB,则小张的属性值仍是AA,需要手动更新为BB。