钉钉签到记录同步插件
1. 简介
1.1 功能简介
钉钉签到记录同步插件,可以方便快捷的将钉钉中的签到数据同步到简道云表单中,让管理员可以使用这些数据计算员工的出勤率和工资等数据。
1.2 适用对象
适用于公共模式和 钉钉集成模式 的账号,不适用于其他模式。
2. 钉钉平台配置
2.1 创建钉钉应用
1)管理员需要 PC 端登录 钉钉开放平台,选择「应用开发 >> 钉钉应用」,点击「创建应用」。如下图所示:
注:该应用会占用钉钉中的 API 调用量。
2)在创建应用详情页中,填写应用名称和应用描述,并上传应用图标后,点击「保存」按钮。如下图所示:
2.2 记录Appkey和AppSecret
在「凭证与基础信息」处,记录下创建的应用的 Appkey 和 AppSecret ,插件配置时需要填写。如下图所示:
3. 插件安装及配置
3.1 安装插件
1)直接安装
- 您可点击右方链接直接安装插件:钉钉签到记录同步插件安装。
- 安装成功后,可参考本文【3.2 配置插件】和【3.3 启用插件】,前往「开放平台 >> 插件管理」处配置并启用插件。
2)插件市场处安装
在简道云「插件市场」处,安装「钉钉签到记录同步」插件。插件市场处安装方法可参见文档:插件市场中【2.3 插件安装】。
3.2 配置插件
1)安装后,在「插件管理」处,点击插件右侧的「设置」按钮,根据【2.3 记录 Appkey 和 AppSecret 】,将「钉钉CorpID」、「AppKey」和「AppSecret」等信息配置进去,配置完成后点击确定。
2)登录简道云,在「账号中心 >> 企业管理 >> 企业信息 >> 账号模式」处,获取钉钉 CorpID。
3.3 启用插件
在插件管理中,打开钉钉签到记录同步打卡插件右侧开关,启用插件。
4. 表单搭建
以获取考勤信息同步为例,新建「考勤签到信息表」,所需要的考勤信息及字段设置如下所示:
字段名称 | 字段类型 | 字段设置 |
签到时间 | 日期时间 | 选择类型:年-月-日 时:分:秒 |
签到地址 | 地址字段、单行文本 | —— |
备注 | 单行文本 | |
签到成员 | 单行文本:默认支持 成员单选:公共模式下,钉钉 userid 和简道云 userid 一致时,支持进行成员单选,考勤数据即可同步到简道云里 注:选用单行文本字段时,成员信息回填后为一串成员 ID,可读性较差。故建议使用成员单选字段类型 |
5. 智能助手同步数据
表单设计完成后,插件获取到的数据,可通过「智能助手」及时同步到表单中。用户可选择以下任一方式推送。
- 定时重复触发:在每天/每周/每月/自定义周期的固定时间,重复触发智能助手任务。
- 定时单次触发:在指定时间,触发一次智能助手任务。
建议先使用「定时单次触发」将历史数据导入表单中,再使用「定时重复触发」定期导入数据。
两种触发方式的设置方法基本一致,本文将以定时重复触发为例,并对定时单次触发的设置差别进行详细描述。
5.1 新建智能助手
表单设计完成后,切换至「扩展功能」页面,在智能助手处,点击新建智能助手,如下图所示:
5.2 设置触发动作
1)智能助手设置如下所示:
- 触发动作:定时重复触发
- 触发时间:2023-08-03 15:07:33
- 重复类型:每天
- 重复触发结束时间:2023-08-18 15:10:00
2)定时重复触发与定时单次触发的设置项不完全相同,具体设置如下表所示:
触发方式 | 设置项 | 简介 |
定时重复触发 | 触发时间 | 定义:何时开始触发智能助手任务 规则:必填项,精确到秒 |
重复类型 | 选项:「每天」/「每周」/「每两周」/「每月」/「每年」/「自定义重复」 规则:必填项,默认值为「每天」 | |
重复触发结束时间 | 定义:何时结束触发智能助手任务 规则,必填项,精确到秒,「重复触发结束时间」不可早于「触发时间」 | |
定时单次触发 | 触发时间 | 定义:何时触发一次智能助手任务 规则:必填项,精确到秒 |
5.3 设置执行动作
1)选择「钉钉签到记录同步」插件,如下图所示:
2)设置表单、同步方式、同步数据起始日期、同步数据结束日期、同步员工范围、同步内容,设置完成后点击「完成」,如下图所示:
3)定时重复触发与定时单次触发的设置项不完全相同,具体设置如下表所示:
设置项 | 简介 |
表单 | 内容同步的目标表单。
|
同步方式 | 同步方式为「仅新增」,即有新数据推送时,只做增量更新,不做覆盖更新。 |
同步数据起始日期 | 1)定时重复触发:设置其为「字段值」,下拉框需选择「上次运行时间」。 2)定时单次触发:可以选择起始日期和结束日期,均使用日期时间字段,精确到具体时分秒;系统将根据用户设定的时间跨度来同步数据。 |
同步数据结束日期 | 1)定时重复触发:设置其为「字段值」,下拉框需选择「当次运行时间」。 2)定时单次触发:可以选择起始日期和结束日期,均使用日期时间字段,精确到具体时分秒;系统将根据用户设定的时间跨度来同步数据。 |
同步员工范围 | 默认为空,可选择组织架构、角色、成员。 最多可选择 1500 个成员,同步时仅同步前 1500 个成员 |
同步内容 | 可将【4. 表单搭建】处展示的字段数据同步到表单对应字段中。 若表单字段不符合字段类型需求,则无法正常同步,可能无法得到同步内容。 |
6. 效果预览
6.1 触发时间
6.1.1 定时重复触发
「定时重复触发」会按照「触发时间、重复类型、重复触发结束时间」计算智能助手「触发时间」,按照「同步数据起始日期」和「同步数据结束日期」计算导入的数据周期。
例如「触发时间」为 2022-10-11 9:00,「重复触发结束时间」为 2022-10-13 9:00,「重复类型」为每天,「同步数据起始日期」为 「上次运行时间」,「同步数据结束日期」为 「当次运行时间」。
那么,智能助手执行逻辑如下:
- 2022 年 10 月 11 日 9:00 首次同步时,其同步数据的起始时间为「上次运行时间」,即 2022 年 10 月 10 日 9:00 (理论上的时间值,实际上该时间点无数据);同步数据的结束时间为「当次运行时间」,即 2022 年 10 月 11 日 9:00。
- 2022年 10 月 12 日 9:00 同步数据时,智能助手同步数据的起始时间依然为「上次运行时间」,即 2022 年 10 月 11 日 9:00;同步数据的结束时间为「当次运行时间」,即 2022 年 10 月 12 日 9:00。故可将「2022-10-11」全天的钉钉打卡数据同步至简道云表单中。
- 2022年 10 月 13 日 9:00 同步数据时,智能助手同步数据的起始时间仍然为「上次运行时间」,即 2022 年 10 月 12 日 9:00;同步数据的结束时间为「当次运行时间」,即 2022 年 10 月 13 日 9:00。故可将「2022-10-12」全天的钉钉打卡数据同步至简道云表单中。
6.1.2 定时单次触发
「定时单次触发」会在「触发时间」将「签到数据起始日期」-「签到数据结束日期」的数据导入表单中。
例如「触发时间」为 2021-05-01 零点,「签到数据起始日期」为 2021-01-01,「签到据结束日期」为 2021-04-01。
那么 2021-05-01 零点智能助手将「2021-01-01~2021-04-01」的钉钉签到数据导入简道云表单中。
6.2 数据同步
设置完成后,智能助手会在指定时间同步数据到表单。如下图所示:
6.3 执行日志
用户可在智能助手处查看任务执行日志,执行日志中可以查看执行时间、执行人、触发动作、执行结果等数据。
当执行失败时可以参照日志进行调整,执行失败的原因如下:
执行结果 | 原因说明 |
执行「钉钉签到记录同步」插件(失败-插件已停用) | 插件安装了但未启用 |
执行「钉钉签到记录同步」插件(失败-插件已卸载) | 请重新安装「钉钉考勤打卡同步」插件 |
执行「钉钉签到记录同步」插件(失败-付费版本过期) | 简道云高级版已到期,请续费 |
执行「钉钉签到记录同步」插件 | 插件执行成功,数据成功新增至表单 |
执行「钉钉签到记录同步」插件 | 插件执行成功,但是没有数据: - 同步的时间范围内,没有数据; -「同步员工范围」只选择了一级部门(需勾选所有子部门) |
执行「钉钉签到记录同步」插件(失败-请检查插件配置) | 插件配置中填写的 Appkey 和 AppSecret 不正确 |
执行「钉钉签到记录同步」插件(失败-执行超时) | 插件执行耗时长,请检查智能助手相关配置 |
执行「钉钉签到记录同步」插件(失败-同步数据量超过 5W 条) | 智能助手单次同步数据量不可超过 5W 条,若数据量过大,请分批多次导入 |
7. 注意事项
1)管理员在 钉钉开放平台 中,创建钉钉应用时,所创建的内部应用会占用钉钉中的 API 调用量
2)公共模式使用钉钉签到记录同步插件时需注意:简道云通讯录中的成员编号应与钉钉中的成员编号保持一致。如下所示:
简道云通讯录中的成员编号,可在「通讯录 >> 内部成员 >> 全部成员」中,点击单条成员数据后,进入成员数据详情页查看并修改。