企业微信开放能力插件
1. 简介
1.1 插件简介
企业微信开放能力插件支持通过简道云表单,在企业微信文档中创建文档、添加智能表以及同步数据。
1.2 应用场景
适用于需要简道云和企业微信双平台同步信息的各类场景中,如成员信息同步、考勤信息同步、项目进度跟踪等。
1.3 预期效果
以通过简道云向企业微信文档智能表中添加成员入职信息为例,效果如下所示:
1.4 使用说明
1)企业微信开放能力插件为免费插件,付费版用户可免费使用。
2)企业微信开放能力插件仅支持简道云企业微信 CP 代开发模式使用,ISV 模式暂不支持。
2. 企业微信平台配置
1)企业微信管理员登录 企业微信管理后台,在「应用管理 >> 应用 >> 自建」处,点击「简道云」。
2)进入简道云应用设置页面中,在「功能 >> 授权信息」处,点击「查看」。
3)在「授权信息 >> 成员基本信息」处,点击「编辑权限」。进入权限编辑页面后,在「基础应用能力相关 >> 文档」处,勾选「文档」权限。勾选完成后,点击「保存更改」。
3. 插件安装及配置
3.1 安装插件
1)直接安装
- 您可点击右方链接直接安装插件:企业微信开放能力插件安装。
- 安装成功后,安装成功后,可参考本文【3.2 配置插件】和【3.3 启用插件】,前往「开放平台 >> 插件管理」处启用插件。
2)插件市场处安装
在简道云「插件市场」处,安装「企业微信开放能力」插件。插件市场处安装方法可参见文档:插件市场中【2.3 插件安装】。
3.2 配置插件
1)安装完成后,在「账户中心 >> 管理后台 >> 企业信息 >> 基础信息」处,复制企业账号的 CorpID。
2)在「插件管理」处,点击插件右侧的「设置」按钮,将获取到的 CorpID 配置进去。
3.3 启用插件
在插件管理中,打开「企业微信开放能力」插件右侧开关,启用插件。
4. 表单搭建
插件使用体验可先安装:企业微信开放能力插件模板。本文将按照示例表单进行讲解。
插件配置需要使用 3 张表单,分别是:
- 创建文档:用于在企业微信中创建一个文档,支持添加文档成员;
- 新建智能表:用于在文档中创建一个智能表格;
- 成员信息同步表:用于在智能表格中添加成员信息数据。
5. 前端事件配置
5.1 创建文档
5.1.1 添加按钮执行动作
进入「创建文档」表单中,点击「是否创建文档」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
5.1.2 设置事件名称和说明
添加好按钮执行动作后,首先设置执行动作的基础信息,即事件名称和事件说明,用于区分前端事件:
5.1.3 设置执行动作
设置执行动作如下:
- 选择插件:选择「企业微信开放能力 >> 创建文档」;
- 文档名:设置为字段值,即「文档名」字段;
- 管理员:设置为字段值,即「文档成员」字段;
- 文档类型:设置为自定义,选择「智能表格」;
- 字段存储关系:点击「添加」按钮,并选择全部字段后进行如下设置:
- 将文档 ID 的值存储到「文档 ID」字段中;
- 将查看链接的值存储到「文档 URL」字段中。
5.2 添加智能表
5.2.1 添加按钮执行动作
进入「新建智能表」表单中,点击「是否创建」按钮字段,在「字段属性 >> 执行动作」处,点击「添加执行动作」:
5.2.2 设置事件名称和说明
添加好按钮执行动作后,首先设置执行动作的基础信息,即事件名称和事件说明,用于区分前端事件:
5.2.3 设置执行动作
设置执行动作如下:
- 选择插件:选择「企业微信开放能力 >> 添加智能表」;
- 文档 ID:设置为字段值,即「文档 ID」字段;
- 智能表名:设置为字段值,即「智能表名称」字段;
- 字段存储关系:点击「添加」按钮,将表格 ID 的值存储到「智能表 ID」字段中;
5.3 在智能表中添加数据列
当【5.1 创建文档】和【5.2 添加智能表】设置完成并成功触发后,需先在创建好的智能表中添加数据列表头,添加完成后,通过智能助手触发的数据才能同步进智能表中。
在「企业微信 >> 文档」中,进入刚刚创建好的文档和智能表中,点击智能表右侧「添加」按钮,根据业务需求添加对应的数据列表头,如员工姓名、入职日期、年龄、民族等。
6. 智能助手配置
6.1 添加智能助手
进入「成员信息同步表」表单中,在「扩展功能 >> 智能助手」处新建智能助手「同步成员信息」,设置触发方式为「表单触发」,并选择触发表为「成员信息同步表」。
6.2 设置触发动作
设置定时触发动作为:当「新增数据时」。
6.3 插件节点设置
1)在节点连接线上点击「添加」按钮,选择「插件节点」。
2)设置插件节点执行动作如下所示:
- 执行插件:选择「企业微信开放能力 >> 添加数据」插件;
- 文档 ID:设置为字段值,即「触发数据-文档 ID」;
- 表格 ID:设置为字段值,即「触发数据-智能表 ID」;
- 数据:点击添加按钮,数据添加如下所示:
- 添加「员工姓名」字段,设置字段类型为「成员」,数据值选择为「字段值 >> 触发数据-成员姓名」;
- 添加「入职日期」字段,设置字段类型为「日期」,数据值选择为「字段值 >> 触发数据-入职日期」;
- 添加「年龄」字段,设置字段类型为「数字」,数据值选择为「字段值 >> 触发数据-年龄」;
- 添加「民族」字段,设置字段类型为「文本」,数据值选择为「字段值 >> 触发数据-民族」;
- 执行结果:设置「数据.数据 ID」为「文本类型」。
注:
1)执行动作中「数据」中的字段名称和字段类型,需与【5.3 在智能表中添加数据列】处设置的列表头名称和字段类型保持一致,否则将执行失败。
2)目前仅支持成员、日期、数字和文本字段,其他类型字段暂不支持。
6.4 效果演示
效果参见本文【1.3 预期效果】。