观远 BI

飞书完全集成方案

创建于 2022-10-30 / 最近更新于 2024-04-26 / 5803
字体: [默认] [大] [更大]

1. 飞书完全集成方案概述

飞书是字节跳动旗下先进协作与管理平台。观远数据支持与云飞书的深度集成,通过飞书开放平台与观远数据管理员设置的简单操作,即可进行集成,打通两个平台的账号体系,进行便捷的数据分析与智能决策。

2. 飞书完全集成价值

观远数据支持与飞书的深度集成,可实现:

  • 观远平台成为飞书的内嵌应用;

  • 从飞书的应用里访问观远,免密登录(包括飞书的移动端和PC端);

  • 观远Web端可用飞书扫码登录;

  • 订阅、预警消息推送至飞书,一键触达。

3. 集成配置步骤

3.1 “飞书开放平台-开发者后台”创建观远BI应用

注:飞书集成仅限私有化部署客户。SaaS环境(app.guandata.com) 由于飞书官方限制了单个IP只能被一个公司使用,暂不支持飞书集成。 观远分析云客户不受此影响。

“飞书开放平台-开发者后台”在开发者后台页面点击创建应用(https://open.feishu.cn/app

在飞书开发者后台,点击“创建应用”:

点击后,填写相关信息即可:

点击确定创建后,该应用会出现在企业自建应用列表中:

点击进入该应用,可获取App ID和App Secret,用于随后在观远管理后台进行配置。App ID与App Secret的获取入口:应用凭证与基础信息页面:

3.2 “观远管理后台”填写飞书企业自建应用相关信息

配置入口:管理员设置—>系统集成—>飞书配置,填写信息包括App ID与App Secret(获取入口如步骤1所述),测试连接成功后完成配置:

填写后,需要"启用",才能正常进行飞书消息推送和免密/扫码登录;同时可获取回调域名以及桌面端主页与移动端主页链接,用于随后在企飞书开发者后台进行企业自建应用配置。

回调地址可从观远管理后台直接获取。私有化环境下,回调域名地址可在 管理员设置->系统管理->高级设置->域名设置 中进行配置,域名的初始状态是http://localhost:3001/,需要改成企业实际域名。

image.png

3.3 “飞书开放平台-开发者后台”在观远BI应用中完成授权配置

点击飞书右上角菜单栏,进入“管理后台”,如下图所示:

点击应用,进入应用的设置页面,以下详细说明:

a.“启用网页”及添加配置(SSO登录流程是基于网页能力实现的,所以要开启这个功能):

1.png

桌面端主页:在桌面端飞书工作台打开应用主页。(桌面端暂不支持调用 Native 能力)

移动端主页:在移动端飞书工作台打开应用主页。

b.“启用机器人”:机器人主要用于和用户进行会话。如果应用仅需要给用户发送通知,也需要开启机器人能力:

c.“配置重定向URL”,入口:安全设置 -> 添加“重定向URL”。(这个也是保证SSO登录流程能正常进行的基本配置,飞书接到登录请求后会重定向到我们的系统,流程才能往下走):


易忽略从而引起配置失败地方:① https与http协议  —— 需要与实际使用的网址一致   ② URL 末尾的 /   —— 需要保留  

d.“配置H5可信域名”:入口:安全设置->H5可信域名。添加URL:

image.png

回调域名地址查看入口:管理员设置->系统集成->飞书

image.png


e.“权限管理”:在开发者后台页面,点击左侧导航栏权限管理,进入权限管理页面。开启你的应用功能所需要的权限:

注意事项:扫描登录功能依赖 [获取用户userid] 权限,请务必申请。  

创建应用版本并且发布应用成功:

3.4【观远管理后台】用户属性中关联飞书账号

飞书配置“启用”后,系统会自动添加一个用户基础属性——“飞书账号”。

管理员可以给单个用户添加,也可以在“用户基础属性”中批量配置“飞书账号”。

用户的飞书账号查看入口:“飞书管理后台”->成员与部门->点击某个用户查看详情:

飞书管理后台—成员与部门—批量导出:

3.5 免密登录到表单

如果需要免密登录到表单填报里,则需要在配置的链接里,host_url后加一个固定的路由(如下),再按照第三方集成要求添加其他参数。

?path_url=survey-engine/

详情请参考《配置链接》

例如:

https://app.mayidata.com?path_url=survey-engine%2Fm%2Fsurvey%2F4bd86aa5-89d3-4b72-8186-a06170cdddbd

填报链接做免密登录链接拼接注意点:

(1)在survey-engine前要加指定参数 “path_url=”

注:参数不能直接跟在“/”后面,只能跟在“?”后面

2)填报链接要做转码

注:转码可以使用一些小工具,如:https://www.bejson.com/enc/urlencode

举例:

表单链接:

https://app.mayidata.com/survey-engine/survey/1b36b7ff-d470-475e-931f-df1ce53b3ed5

拼接后的免密登录链接:

https://app.mayidata.com?path_url=survey-engine%2Fsurvey%2F1b36b7ff-d470-475e-931f-df1ce53b3ed5&……(其他参数)

4. 效果展示

PC端登录页面出现飞书登录入口,点击后可进行扫码登录,若有登录飞书PC端即可通过授权进行免密登录:

飞书移动端以及PC端工作台中,可看到创建的应用,点击进入即可免密登录到观远平台H5界面。

订阅、预警消息推送至飞书,在配置订阅、预警通知渠道时,可以选择“飞书”作为触达方式:

3.6 免密登录到应用

如果需要从飞书工作台进入bi后,免密登录到某一个具体的应用里,则需要对飞书应用的主页地址进行调整,将path_url={应用地址除去BI域名部分}内容增加上去。bi后台默认的主页地址只能登录到应用主页面,不会进入到某一个具体的应用。

以桌面端应用主页为例,移动端也是一样的方法,将对应的内容拼接到path_url后面。

bi后台自动生成的桌面端主页地址
https://open.feishu.cn/open-apis/authen/v1/index?redirect_uri=https%3A%2F%2Fuat.guandata.com%2Fbi-test%2F%3Fprovider%3Dfeishu%26domain%3Dtesting%26path_url%3D&app_id=cli_a3023e14602a600b&state=pc
想要免密登录的桌面端应用地址
https://uat.guandata.com/bi-test/home/web-app/a0a4e3210ca504685bac55b1

则需要在桌面端主页地址path_url%3D后面拼接加密后的{应用地址除去BI域名部分},即将/bi-test/home/web-app/a0a4e4150ca504685bac55b1,加密后拼接到path_url%3D后,加密后的内容:%2Fbi-test%2Fhome%2Fweb-app%2Fa0a4e4150ca504685bac55b1,生成新的桌面端主页地址,替换到飞书后台的桌面端主页即可。

拼接后的桌面端主页地址
https://open.feishu.cn/open-apis/authen/v1/index?redirect_uri=https%3A%2F%2Fuat.guandata.com%2Fbi-test%2F%3Fprovider%3Dfeishu%26domain%3Dtesting%26path_url%3D%2Fbi-test%2Fhome%2Fweb-app%2Fa0a4e3210ca504685bac55b1&app_id=cli_a3023e14602a600b&state=pc

报错详见 请求非法,请联系应用开发者

在飞书管理员后台,将桌面端主页地址替换成拼接web-app之后的地址,即可实现免密登录后具体的桌面端应用。

image.png

轻应用做免密登录链接拼接注意点:

(1)在path_url后要加应用地址除去BI域名部分,应用地址可以打开桌面端门户,预览点击需要跳转的应用,在浏览器中复制具体桌面端门户应用地址

image.png

image.png

(2)桌面端门户地址要做转码

需要转码的部分:{BI域名地址?}和{应用地址除去BI域名部分}

注:转码可以使用一些小工具,如:https://www.bejson.com/enc/urlenco

27 人点赞过