页面树结构
转至元数据结尾
转至元数据起始

1 概述

此文档就 对话式分析功能的飞书集成 的方法进行了详细阐述,其编写主要目的是为了方便用户更流畅、便捷地了解功能的具体细节。部署完成后效果如下:

图1. 飞书工作台界面


图2. 飞书网页应用效果


2 部署方法

2.1 设置飞书应用

2.1.1 创建飞书网页应用

通过以下网站,登录开发者后台: https://open.feishu.cn/app?lang=zh-CN

点击 “创建企业自建应用” 

2.1.2 配置&发布应用

1. 点击 “添加应用能力”

【添加应用能力】


2. 在网页应用配置界面中填入对话式分析的地址: <Smartbi地址>/vision/AIChatView3.html

以下以 http://proj.smartbi.com.cn:19060/smartbi/ 为例

【配置网页应用】


3. 给应用进行飞书权限授权

【配置应用权限】


需要给到应用配置以下权限:

权限名称

权限说明

使用场景

contact:contact:readonly_as_app

以应用身份读取通讯录

用户同步

contact:department.organize:readonly

获取部门组织架构信息

用户同步

contact:user.base:readonly

获取用户基本信息

用户同步

contact:user.employee_id:readonly

获取用户user ID

用户同步

contact:user.phone:readonly

获取用户手机号

用户同步


4. 配置安全设置

添加一个重定向的URL,在跟飞书交互时,会用到Oauth2登陆认证,飞书接受到登录请求后,会重定向回smartbi,并携带相关code信息。

此处需要将smartbi解析code并登录的地址配置到重定向URL内。

以下以 http://proj.smartbi.com.cn:19060/smartbi/ 为例,应该设置重定向地址为:

 http://proj.smartbi.com.cn:19060/smartbi/vision/FeiShuOauthLogin


5. 发布应用

2.1.3 配置应用用户范围

1.管理员登陆飞书后,点击头像,选择并点击“管理员后台”


2. 展开 “工作台“ - 打开 “应用管理” - 搜索应用名称 - 点击 “配置”


3. 配置应用的用户范围

2.2 安装&配置飞书集成拓展包

2.2.1 获取&安装拓展包

使用如下链接内的拓展包:

飞书集成对话式分析功能扩展包下载

采用Smartbi的标准方式进行拓展包的安装部署,具体方法参考:

http://wiki.smartbi.com.cn/pages/viewpage.action?pageId=69733090

更新扩展包之前,请做好知识库以及扩展包的备份。

2.2.2 配置拓展包

拓展包安装完成以后进入依次 运维设置 - 系统选项 - 飞书集成,在对应的栏位输入飞书的应用信息

集成应用信息的来源是,在飞书开发者控制台的 “凭证与基础信息”页面中:

2.2.3 同步用户/用户组信息

请务必先同步用户组信息,后同步用户信息, 否则会导致任务执行失败且系统出现设置混乱。

同步用户组/用户信息前一定要确认应用是否已经授权了获取用户信息的权限,详情见:本文档2.1.2小节的第3步


1. 同步用户组信息

找到 运维设置 - 模块配置与管理 - 计划任务 -  任务,点击 “新建任务”,创建一个新的任务:


将下面提供的脚本粘贴到代码编辑区,效果如图 :

connector.remoteInvoke("FeiShuCommonModule","syncFeiShuGroup",[]);


保存后点击“测试运行“,进行用户组同步。


2. 同步用户信息

同上述步骤创建计划任务,并填入如下代码,点击“测试运行“执行任务

connector.remoteInvoke("FeiShuCommonModule","syncFeiShuUser",[true]);


3.设置计划自动执行

飞书的用户可能随着客户的使用而增加,客户可以自行选择手动运行,或者利用计划任务来定期自动执行同步操作。以下示例展示如何设置计划任务进行自动同步:

进入运维设置 - 模块配置与管理 - 计划任务 -  计划,点击 “新建计划”,选择上述创建的两个任务,设置自动执行的周期:

详细配置方法见WIKI: 

https://wiki.smartbi.com.cn/pages/viewpage.action?pageId=111885898


2.3 验证安装效果

利用普通用户登陆飞书,点击 “工作台”,找到对应的应用名称,如图:


点击进入界面,可以正常的展示界面即为正常。

  • 无标签