钉钉通讯录插件
1. 简介
1.1 功能简介
钉钉通讯录插件,可以方便在钉钉集成模式下的简道云中管理钉钉的通讯录人员及部门信息,并管理入职、离职、职位变动等信息。
1.2 使用场景
适用于钉钉集成模式的简道云,需要在简道云中直接对通讯录人员、部门进行增删改等操作的场景中。
1.3 预期效果
以使用「创建用户」函数,在简道云创建钉钉通讯录人员为例,效果如下所示:
1.4 使用说明
1)该插件适用于简道云企业版且为钉钉集成模式的简道云,需要具有 API 权限才能使用,并确保具有简道云对应表单的操作权限。
2)该插件包含 6 种事件,如下所示:
- 创建钉钉用户
- 修改钉钉用户
- 删除钉钉用户
- 创建钉钉部门
- 修改钉钉部门
- 删除钉钉部门
3)该插件为付费插件,请联系我们增购。插件购买流程如下所示:
2. 钉钉平台配置
2.1 创建钉钉应用
1)管理员需要 PC 端登录 钉钉开放平台,选择「应用开发 >> 钉钉应用」,点击「创建应用」。如下图所示:
注:该应用会占用钉钉中的 API 调用量。
2)在创建应用详情页中,填写应用名称和应用描述,并上传应用图标后,点击「保存」按钮。如下图所示:
2.2 权限申请
在应用开发详情页中,进入「权限管理 >> 通讯录管理」处,勾选「维护通讯录的接口访问权限」并点击「申请权限」按钮。如下图所示:
2.3 记录Appkey和AppSecret
在「凭证与基础信息」处,记录下创建的应用的 Appkey 和 AppSecret ,插件配置时需要填写。如下图所示:
3. 插件安装及配置
3.1 安装插件
1)直接安装
- 您可点击右方链接安装插件模板:钉钉通讯录插件安装链接。
- 安装成功后,可参考本文【3.2 配置插件】和【3.3 启用插件】,前往「开放平台 >> 插件管理」处配置并启用插件。
2)插件市场处安装
在简道云「插件市场」处,安装「钉钉考勤请假同步」插件。插件市场处安装方法可参见文档:插件市场中【2.3 插件安装】。
3.2 配置插件
安装后,在「插件管理」处,点击插件右侧的「设置」按钮,进行如下所示配置:
- 应用 Key:将【2.3 记录 Appkey 和 AppSecret 】中获取到的 Appkey 配置进「应用key」中;
- 应用 Secret:将【2.3 记录 Appkey 和 AppSecret 】中获取到的 AppSecret 配置进「应用 Secret」中;
- 简道云 Key:管理员登录简道云,在「开放平台 >> 密钥管理」中,创建并复制简道云的 APIKey。
3.3 启用插件
在插件管理中,打开钉钉通讯录操作插件的右侧开关,启用插件。
4. 表单搭建
插件使用体验可先安装:钉钉通讯录操作应用模板。本文将按照示例表单进行讲解。
1)插件的功能及配置需要使用 6 张表单,分别是:
- 创建用户:用于填写员工的基本信息,如员工名称、手机号码、员工工号、所属部门等;
- 用户信息修改:从通讯录中选择要修改的用户,进行将用户的基本信息进行修改,如员工名称、手机号码、员工工号、所属部门等;
- 用户删除:从通讯录中选择要删除的用户,提交后触发插件将该用户从钉钉通讯录中删除。
- 部门创建:用户填写部门基础信息,如部门名称、父部门、是否隐藏本部门、是否限制本部门成员查看通讯录等。
- 部门信息修改:从通讯录中选择要修改的部门,进行将部门的基本信息进行修改,如部门名称、父部门、是否隐藏本部门、是否限制本部门成员查看通讯录等。
- 部门删除:从通讯录中选择要删除的部门,提交后触发插件将该部门从钉钉通讯录中删除。
2)表单设计完成后,在「扩展功能>>数据推送」处,点击「设置字段别名」,来配置每个表单字段的字段别名。
- 请求钉钉状态:dd_stat
- 钉钉返回内容:dd_res
注:上述 6 张表单均需配置字段别名。
5. 智能助手Pro设置
表单设计完成后,可通过「智能助手Pro」监听表单的操作来触发插件。用户可选择 在一张表单或多张表单中触发插件。
- 将用户或部门的创建、修改、删除归纳在一张表单中,通过智能助手对数据的监听创建、修改、删除来触发执行不同的插件。
- 将用户或部门的创建、修改、删除分开多张表单,用于记录各自修改及操作的数据信息,可以通过智能助手的创建或审批流完成来触发插件的执行。
建议智能助手使用不太熟练的用户先使用「分开多表单记录」的触发方式。
5.1 新建智能助手Pro
表单制作完成后,切换至「扩展功能」页面,新建智能助手Pro,如下图所示:
5.2 设置触发动作
智能助手比较灵活,可根据自己具体使用的场景来设置,模板表单中的智能助手设置如下所示:
- 触发动作:新增数据时
- 触发条件:无
思路拓展:
- 如果要新增的用户需要进行审批后才可以去钉钉创建,触发动作可以为「流程结束时」或者「流程到达某个节点」,然后审批字段为「同意」时才可以。
- 若需要在创建、修改、删除时进行同步,可以将触发动作设置为新增时触发插件创建、修改时触发插件修改、或删除时触发插件删除。
5.3 设置执行动作
执行动作选择插件节点,选择插件「钉钉通讯录操作」,根据不同的表单或者操作选择不同的插件函数,字段值根据表单的内容对应起来即可。以新增客户为例,如下图所示:
6. 问题排查
插件在每个操作中都会往表单中返回执行状态以及钉钉返回值的原始内容,可在每个表单中设置以下两个字段来排查问题。
名称 | 内容含义 | 字段类型 |
请求钉钉状态 | 别名:dd_stat | 单行文本 |
钉钉返回内容 | 别名:dd_res | 单行文本 |
7. 联系方式
该插件为官方合作的服务商开发,若您在使用过程中有任何疑问,可通过以下方式咨询:
- 公司:青岛英哲信息科技有限公司
- 联系人:马显洲(Steven/九米)
- 联系电话:137 8065 2165