飞书自建应用插件
1. 简介
1.1 插件简介
飞书自建应用插件支持简道云与飞书数据消息互通,如:日历日程同步增删,实现便捷管理,提升企业内部协作效率。
1.2 应用场景
适用于需要根据业务表单信息自动给相关人员创建飞书日历日程的场景中。如客户拜访日程、活动日程、任务日程等等。
1.3 预期效果
以新建文档部门日历并创建/删除会议日程为例,效果如下所示:
1.4 使用说明
飞书自建应用插件为免费插件,付费版用户可免费使用。
2. 飞书平台配置
插件使用前,需前往飞书平台,获取应用 ID 和应用 secret,详情可参见:创建并配置应用。
2.1 创建应用
1)登录 飞书开放平台,在「开发者后台」处,点击「创建企业自建应用」:
2)在创建企业自建应用的详情页中,设置应用名称、应用描述和应用图标。设置完成后,点击「创建」按钮。
2.2 添加机器人
在「添加应用能力 >> 按能力添加」处,找到机器人并点击「添加」。
2.3 配置应用权限
在「权限管理 >> API 权限」处,为应用添加以下权限:
- 获取用户 user ID
- 更新日历及日程信息
- 获取日历、日程及忙闲信息
- 获取会议室信息
以添加「获取用户 user ID」权限为例,操作步骤如下所示:
2.4 获取应用ID和应用Secret
在「凭证与基础信息 >> 应用凭证」处,查看并获取应用 ID 和应用 Secret。
2.5 发布应用
在「版本管理与发布」处,点击「创建版本」按钮,填写应用版本号、更新说明,修改应用可用范围为「全部员工」。修改完成后,保存当前应用。
3. 插件安装及配置
3.1 安装插件
1)直接安装
- 您可点击右方链接直接安装插件:飞书自建应用插件安装。
- 安装成功后,安装成功后,可参考本文【3.2 配置插件】和【3.3 启用插件】,前往「开放平台 >> 插件管理」处启用插件。
2)插件市场处安装
在简道云「插件市场」处,安装「飞书自建应用」插件。插件市场处安装方法可参见文档:插件市场中【2.3 插件安装】。
3.2 配置插件
安装完成后,在「插件管理」处,点击插件右侧的「设置」按钮,将【2.4 获取应用ID和应用Secret】中获取到的应用 ID 和应用 Secret 配置进去。
3.3 启用插件
在插件管理中,打开「飞书自建应用」插件右侧开关,启用插件。
4. 表单搭建
插件使用体验可先安装:会议室预约系统模板。本文将按照示例表单进行讲解。
插件配置需要使用 3 张表单,分别是:
- 文档部门日历表:用于创建一个文档部门的日历,日历为订阅制,分享后非部门成员也可查看;
- 会议日程表:用于在日历中创建一个日程事件;
- 删除日程表:用于删除确认需要取消的日程事件。
5. 前端事件配置
5.1 创建日历
5.1.1 添加按钮执行动作
进入「文档部门日历表」,点击「是否创建日历」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
5.1.2 设置事件名称和说明
添加好按钮执行动作后,首先设置执行动作的基础信息,即事件名称和事件说明,用于区分前端事件:
5.1.3 设置执行动作
设置执行动作如下:
- 选择插件:选择「飞书自建应用 >> 创建日历」;
- 日历标题:设置为字段值,即「日历标题」字段;
- 日历描述:设置为字段值,即「日历描述」字段;
- 日历管理员:设置为字段值,即「日历管理员」字段;
- 颜色:设置为自定义,企业可根据业务需求在下拉框中自定义设置颜色,如青色;
- 公开范围:设置为自定义,即「日历标题」字段;
- 字段存储关系:点击「添加」按钮,设置「日历ID」的值存储到「日历ID」中。
设置完成保点击「保存」。
5.2 创建日程
5.2.1 添加按钮执行动作
进入「会议日程表」,点击「是否创建日程」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
5.2.2 设置事件名称和说明
添加好按钮执行动作后,首先设置执行动作的基础信息,即事件名称和事件说明,用于区分前端事件:
5.2.3 设置执行动作
1)设置执行动作如下:
- 选择插件:选择「飞书自建应用 >> 创建日程」;
- 日历 ID:设置为字段值,即「日历 ID」字段;
- 日程标题:设置为字段值,即「会议标题」字段;
- 日程描述:设置为字段值,即「会议描述」字段;
- 开始时间:设置为字段值,即「会议开始时间」字段;
- 结束时间:设置为字段值,即「会议结束时间」字段;
- 参会者:可自定义设置,本案例中以一个企业成员和一个外部邮箱为例。具体参数设置可参见【6.执行动作参数说明】
- 日程地点:设置为字段值,即「会议地址」字段;
- 日程公开范围:设置为自定义,支持选择跟随日历权限/显示日程详情/仅自己可见详情;
- 参与人权限:设置为自定义,支持选择无权限/可查看参与人/可邀请参与人/可编辑日程;
- 占用忙闲:设置为自定义,支持选择忙/闲。
设置完成保点击「保存」。
2)设置字段存储关系和子字段填充方式如下:
- 字段存储关系:点击「添加」按钮并选择全部字段后进行如下设置:
- 将日程 ID 的值存储到「日程 ID」字段中;
- 将参会者列表.参与人类型的值存储到「参会人.参会人类型」字段中;
- 将参会者列表.参与人 ID 的值存储到「参会人.参会人 ID」字段中;
- 将参会者列表.参与人名称的值存储到「参会人.参会人名称」字段中;
- 子字段填充方式:设置为「先清空子表单再填充」。
全部设置完成后,点击「保存」按钮。
5.3 删除日程
5.3.1 添加按钮执行动作
进入「删除日程表」,点击「是否删除日程」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
5.3.2 设置事件名称和说明
添加好按钮执行动作后,首先设置执行动作的基础信息,即事件名称和事件说明,用于区分前端事件:
5.3.3 设置执行动作
设置执行动作如下:
- 选择插件:选择「飞书自建应用 >> 删除日程」;
- 日历 ID:设置为字段值,即「日历 ID」字段;
- 日程 ID:设置为字段值,即「日程 ID」字段;
设置完成保点击「保存」。
5.4 效果演示
效果参见【1.3 预期效果】。
6. 执行动作字段说明
创建日程函数中,执行动作部分字段说明如下所示:
字段名称 | 是否必填 | 字段来源 | 字段说明 |
参会者类型 | 必填 | 自定义 | 自定义选择配置参会者类型,支持选择:
|
是否可选参加 | 成员可以自行选择是否参加日程。支持设置是/否:
| ||
参会者字段 | 表单字段值 | 选择表单内的参会成员字段 | |
成员选择 | 非必填 | 自定义 | 除表单内的参会成员外,可自行选择日程的固定成员。 注:若参会者字段和成员选择字段均设置,则创建日程时会合并两个字段中的成员。 |
日程公开范围 | 必填 | 自定义/表单字段值 | 日程详情的公开查看范围,支持以下 3 种类型:
|
参与人权限 | 自定义/表单字段值 | 日程参与人的查看权限,支持以下 4 种类型:
| |
占用忙闲 | 自定义/表单字段值 | 创建日程后,显示成员的空闲程度,支持选择忙或闲。 |