跳到主要内容
版本：7.1.0

将BI可视化图表内嵌至飞书云文档

前提条件

  1. 在观远与飞书的管理后台，完成观远与飞书集成的准备工作，具体操作请参考观远飞书集成配置步骤。

  2. 观远BI平台需要开启HTTPS才可以被飞书云文档内嵌访问；同时需要由运维工程师修改配置文件来打开跨域配置，确保内嵌场景可以正常使用。

  • 文件位置：/home/guandata/Development/guandata-web/guandata-web-configmap.yaml

    修改内容：

    • {"CROSS_SITE_HEADER_TOKEN_ENABLED": true}
    • {"COOKIE_ATTRIBUTES": {"sameSite": "none"}}

  • 文件位置：/home/guandata/Development/guandata-web/guandata-nginx-configmap.yaml

    修改内容：根路径下添加

    • proxy_cookie_path / "/; Secure";

操作步骤

  1. 观远BI平台中，获取可视化卡片或仪表板的【飞书集成链接】。

  2. 在飞书云文档中插入可视化卡片或仪表板，实现图文混排的报告编写，具体方式分为以下两种。

  • 方式一：文档编辑者在飞书云文档中直接插入相应链接，并选择【预览视图】；用户在飞书客户端/浏览器中访问云文档时，可以直观查看可视化图表的分析细节。

说明：通过该方式插入的内嵌块，在PC端的飞书客户端/浏览器中访问云文档时，均可以正常查看可视化图表；在部分机型的iOS或安卓客户端上访问云文档时，由于浏览器安全机制的限制，会发生无法免密登录的情况。

类型
说明
图示
PC端飞书客户端首次登录即可实现SSO登录
PC端浏览器首次登录需要手动授权
部分机型的移动客户端无法免密登录|250

  • 方式二：在飞书云文档中插入【文档小组件】>【观远数据】，贴入相应链接。

    1. 管理员在飞书的管理后台，完成【文档小组件】的安装工作，具体操作请参考云文档小组件安装流程。

    2. 文档编辑者在飞书云文档中插入【文档小组件】>【观远数据】，贴入相应链接。

    注意：每个文档编辑者在首次使用该【文档小组件】时，需要进入【更多小组件】中找到该文档小组件，进行手动【添加】，完成该操作后该用户在所有文档中均可使用该文档小组件。

    首次使用该【文档小组件】时进行添加：

    可通过以下两种方式插入组件：

    插入组件后，贴入相应链接：

    |550

    1. 用户在飞书客户端/浏览器中访问云文档时，可以直观查看可视化图表的分析细节。

    说明：通过该方式插入的内嵌块，无论在PC端的飞书客户端/浏览器中访问云文档，还是在各种机型的iOS或安卓客户端上访问云文档时，均可以实现SSO免密登录正常查看可视化图表。

云文档小组件安装流程

  1. 创建云文档小组件

    在飞书应用后台选择「添加应用能力 > 云文档小组件」，单击「添加」。

    注意：需要在观远数据后台绑定的飞书应用下创建，否则无法完成sso登录。

  2. 在本地控制台安装云文档小组件上传环境

    如您安装过开发者工具，请先执行npm uninstall @bdeefe/opdev-cli -g清理环境，完成之后再使用安装包安装，避免路径被覆盖。

    使用命令行安装需要依赖 Node.js。安装方式请参考 Node.js，安装 Node.js 的同时会自动安装 npm。

    npm install @lark-opdev/cli@latest -g

  3. 命令行执行登录

    1. 执行opdev login，选择 Feishu 。

      |350

    2. 完成后，自动启动浏览器跳转到登录页面进行登录，登录成功后，再次执行opdev login。

    3. 看到如下输出证明登录成功。

说明：步骤2，3参照飞书文档：02 快速上手

  1. 下载安装包

    下载地址：https://guandata-tool.oss-cn-shanghai.aliyuncs.com/1.0.0.zip

  2. 修改文件中对应的appid（飞书应用id）和blockTypeID（云文档小组件id）

    1. 从飞书应用后台，获取APP ID以及BlockTypeID。

      |550

    2. 将获取的APP ID添加至所下载的安装包的/dist/project.config.json文件中；获取的BlockTypeID添加至所下载的安装包的/dist/index.json文件中。

      |650 |650

  3. 上传安装包

    控制台移动到安装包所在目录下，执行opdev upload ./dist，依次输入版本号、描述（可选）。

    |550

  4. 应用后台编辑

    1. 进入导航栏「应用能力 > 云文档小组件」，编辑云文档小组件信息并保存。

    2. 进入导航栏「安全设置 > 服务器域名白名单」，添加服务器白名单，白名单的值为BI的访问地址。

    3. 进入导航栏「开发配置 > 权限管理」，添加小组件的api权限：【创建及编辑新版文档】，【查看新版文档】。

  5. 发布应用版本

    进入导航栏「应用发布 > 版本管理与发布」，发布应用版本。

  6. 云文档内添加组件

    在云文档的添加菜单中找到「更多小组件 > 企业自建」，单击「添加」按钮（每个用户初次使用时都需要添加一次，添加后该用户在所有文档中均可使用该组件）。