1. 概述编辑
1.1 版本
使用钉钉集成,需要 FineBI 、H5 、钉钉插件版本均匹配才能集成,FineBI 5.0 及 5.1 版本的对应情况如下表所示:
FineBI 版本 | JAR 包版本 | HTML5 移动端展现插件 | 钉钉管理插件 |
---|---|---|---|
5.0 | 2018-12-20 | V10.1.02 | V10.0.49 及之后 |
5.1 | 2019-04-03 | V10.2.16 | V10.1.14 及之后 |
注2:钉钉管理插件支持代理服务器的配置,若有些用户 FineBI 服务器是配置在内网,则需要配置代理服务器地址,来进行钉钉的访问,配置方法参考 代理服务器配置
1.2 应用场景
用户如果将钉钉作为移动端办公平台,可以通过安装此插件直接将 BI 集成到钉钉中,以钉钉为统一入口进行仪表板的查看。
1.3 功能简介
安装钉钉管理插件,就可以实现钉钉集成。
在钉钉管理中配置钉钉平台的基本参数,就可以读取到钉钉平台通讯录,将 BI 用户与钉钉用户绑定,就可以实现单点登录。
在定时调度的输出设置中,可以配置并推送钉钉消息。
支持集成多个企业应用,进行钉钉升级时请注意进行兼容设置。
注1:钉钉集成下若使用「扫码控件」, 要求 单点登录
注2:JAR 包为 2020-08-04 及之后、「微信管理」插件版本为 V10.4.69 及之后时,微信集成支持 集群配置
2. 示例编辑
2.1 安装插件
点击下载插件:钉钉管理 、HTML5 移动端展现插件
插件安装方法参照 插件管理
2.2 新建 H5 微应用
1)管理员登录钉钉企业号,在「工作台」Tab 页下点击自建应用,如下图所示:
2)在左侧 Tab 中点击H5微应用,点击创建应用,如下图所示:
2.3 配置 H5 微应用
1)填写应用名称,上传应用 Logo,填写应用简介,开发方式选择企业内部自主开发,点击下一步。如下图所示:
2)开发模式选择开发应用,开发应用类型选择微应用,应用首页地址可以先填数据决策系统的地址,具体的地址需要在后续步骤生成后,将生成的链接再粘贴过来,设置服务器出口 IP,点击创建。如下图所示:
服务器出口 IP 获取方法本文提供 4 种,如下所示:
百度浏览器中输入 IP 获取地址
点击右边链接获取:获取服务器出口IP
Linux 系统中,输入 curl ifconfig.me 获取
打开 cmd 命令窗口,输入如下指令:ping 域名(内网映射到外网的域名)如下图所示:
2.4 应用发布
在 应用发布 Tab 页下点击确认发布,选择可使用范围后,点击保存修改。如下图所示:
注:可使用范围应以部门为主,不能选择到个人。
2.5 获取参数值
1)需获取的四个参数及说明如下表所示:
参数 | 说明 |
---|---|
AgentID | 在创建应用时,系统会自动生成一个 AgentID,可用于发送企业会话消息等场景 |
AppKey | 在创建应用时,系统会自动分配一对 AppKey 和 AppSecret,该 AppKey 是应用开发过程中的唯一性标识 |
AppSecret | AppSecret 和上面 AppKey 一同生成,使用 AppKey 和 AppSecret 来换取 access_token |
CorpID | 企业 ID |
2)在新创建的应用中点击查看详情,即可查看 AgentID、AppKey、AppSecret 这三个参数的值。如下图所示:
3)首页查看企业的 CorpID,如下图所示:
2.6 平台中添加钉钉应用
以管理员身份进入数据决策系统,点击管理系统>钉钉管理,如下图所示:
2.6.1 保存报表服务器地址
必须设置报表服务器地址并保存,如果不设置,推送的时候可能会有问题,例如:http://secure.finedevelop.com:65081/webroot/decision
输入「报表服务器地址」,如下图所示:
2.6.2 新建钉钉应用
点击新建钉钉应用按钮,将本文 2.4 节已确认的 AgentID、CorpID、AppKey、AppSecret 分别填到钉钉应用 ID、CropID、AppKey、AppSecret 中,点击确定。如下图所示:
注:请填写合乎规范的信息,钉钉应用名称、钉钉应用 ID(AgentId)、CropID、AppKey、AppSecret 均不可为空,且钉钉应用名称不可重复。
新建钉钉应用成功后,可对信息进行修改和删除,支持集成多个钉钉应用。如下图所示:
2.7 应用快捷配置
2.7.1 钉钉代理跳转
内网环境:
若 BI 服务器是配置在内网,则需要配置代理服务器地址,来进行钉钉的访问。如下图所示:
注:钉钉集成既需要设置正向代理,也需要设置反向代理,配置方法参考 代理服务器配置
文本框中输入正确的代理服务器地址,点击测试连接,连接成功后,会提示信息:连接成功
外网环境:
外网环境不需要设置代理服务器地址。
2.7.2 生成钉钉链接
选择相应的钉钉应用名称和链接页面,点击生成链接,生成钉钉链接,点击复制,如下图所示:
2.8 修改首页地址链接
用户若需要设置 PC 端单点登录,参考本文 2.8.2 节内容;若不需要设置 PC 端单点登录,请忽略本文 2.8.2 节内容。
2.8.1 应用首页地址
1)进入本文 2.3 节中已创建的H5微应用,点击查看详情>修改,如下图所示:
2)将生成的链接粘贴到应用首页地址,点击提交,如下图所示:
2.8.2 PC 端首页地址
1)版本要求
JAR 为 2020-08-04 及之后,钉钉管理插件为 V10.4.69 及之后,HTML5 移动端展现插件版本为 V10.4.45 及之后时,钉钉集成支持 PC 端单点单点登录 。
注:若用户使用的钉钉管理插件为 V10.4.69 版本,但 URL (本文 2.7.2 节生成的链接)依然使用之前已生成的链接,会显示 H5 的效果。
2)具体步骤
用户若需要设置 PC 端单点登录 ,需填写PC端首页地址,该地址与「应用首页链接」地址一致。
2.9 开启权限
点击接口权限,开启通讯录只读权限和手机号码信息权限。如下图所示:
2.10 成员管理
2.10.1 用户匹配方式
可根据实际情况选择一种用户匹配方式。
用户匹配方式:钉钉工号匹配、手机号匹配、手动匹配、自定义匹配,默认为钉钉工号匹配。「成员管理」页面如下图所示:
注:不管集成几个钉钉应用,用户统一进行管理。
钉钉工号匹配:
钉钉工号匹配和手机号匹配展示列相同。
钉钉工号匹配,则是钉钉工号与 BI 里的用户名匹配,为一对一匹配。
手机号匹配,钉钉用户的手机号是唯一的,但是 BI 用户可以设置多个用户有同一个手机号,此时的匹配逻辑为哪个 BI 用户先创建则匹配哪个
选择这两个匹配方式时,钉钉通讯录信息展示:姓名、钉钉工号、钉钉成员ID、钉钉部门和钉钉成员手机号,如下图所示:
手动匹配:
当匹配方式为手动匹配时,钉钉成员列表中多出「报表用户名」一列信息,点击出现下拉框,选择相应的报表用户名,进行手动匹配。如下图所示:
注1:手动匹配时,报表用户名支持选择「不选」选项。
注2:手动匹配方式是用户可以自由选择与钉钉用户匹配的 BI 用户,可实现多个钉钉用户匹配同一个 BI 用户。
自定义匹配:
即通过设置的服务器数据集,将对应数据列的钉钉用户和 BI 用户相匹配。若出现一个钉钉用户对应了多个 BI 用户的情况,默认匹配第一个 BI 用户。
选择自定义匹配时,下方多出「匹配设置」项,选择数据集、钉钉成员ID以及报表用户名,进行匹配。如下图所示:
2.10.2 通讯录更新
点击左侧立即更新按钮,立即更新通讯录内容。也可设置定时更新,点击自动更新按钮,弹出设置框,设置更新频率。如下图所示:
注1:用户匹配方式为「钉钉工号匹配」或「手机号匹配」时,如果用户增删改 BI 用户或者在后台增删改钉钉用户,需要手动同步通讯录更新。
注2:用户匹配方式为「手动匹配」或「自定义匹配」时,如果用户增删改 BI 用户或者在后台增删改钉钉用户,无需更新同步。
2.11 效果查看
登录钉钉,点击工作台>文档测试,该用户会看到自己权限内可以查看的目录,如下图所示:
3. 消息推送编辑
1)参考[通用]定时任务推送消息至 App ,「文件处理」步骤中选择钉钉通知即可,如下图所示:
2)钉钉用户登录钉钉,可收到消息。如下图所示:
4. 注意事项编辑
4.1 内网访问白名单
在做钉钉集成时,有的客户为内网环境,不允许所有网页都能访问,但要确保能访问钉钉的域名:https://oapi.dingtalk.com/