HR与中控平台数据同步程序开发文档

# 1.   文档说明

本文档作为乐的文化管理系统的HR考勤机的员工基本信息同步程序，对全国所有门店考勤机的员工信息做自动同步更新程序的开发文档，对项目中使用的技术标准和技术开发方案进行描述。

# 2.   项目目标

由于全国所有门店员工信息都由公司总部进行统一管理，所以门店员工考勤数据都在系统中统一存储管理，当某一员工信息有更新时，门店考勤机设备中的员工信息未能即时更新，此时需要将HR数据同步到考勤系统中，介于HR系统与考勤系统它们又是两套独立运行的系统，数据未能连通，要想做到HR系统数据直接被考勤系统使用，需要用第三方程序将HR系统数据即时同步到考勤系统中，由考勤系统中控下发到新增或修改员工所属门店考勤机内，以便员工在后期可以正常考勤。

以及将考勤系统中的员工考勤数据即时同步到HR系统中，方便后续HR对员工出勤进行统计，准确结算每月薪资等后续业务。

通过以上目标的实现，最终可以达到将新增员工和修改员工信息即时同步到考勤系统，以便下发到全国各门店考勤机需求，以达到整个数据即时性、完整性、统一性、安全性、可追溯性机制，从而满足工作需要，提高工作效率。

# 3.数据表设计

| 表 名    |          |
| -------- | -------- |
| 中文描述 |          |
| 建立日期 |          |
| 列 名    | 中文描述 |
|          |          |
| 补充说明 |          |

# 4.数据字典/全局变量

4.1 数据字典

| **字典名称** | **类型** | **键** | **值** |
| ------------------ | -------------- | ------------ | ------------ |
|                    |                |              |              |

4.2 全局变量

| 变量名称 | 访问路径 | 值 | 说明 |
| -------- | -------- | -- | ---- |
|          |          |    |      |

# 5.接口设计

### 5.1

**说明：HR****系统获取token****接口**

调用：

| **调用URL** | https://hr.meland.com.cn:8099/third/getToken?clientId=XXXX&secret=XXXX&second=3600000 |
| ----------------- | ------------------------------------------------------------------------------------- |

入参：

| **参数名** | **类型** | **说明**          | **备注** |
| ---------------- | -------------- | ----------------------- | -------------- |
| clientId         | String         | 业务系统代码            | 必填           |
| secret           | string         | 业务系统秘钥(DHG中生成) | 必填           |
| second           | int            | 有效期间(单位：秒)      | 必填           |

出参：

| **参数名** | **类型** | **说明**    |
| ---------------- | -------------- | ----------------- |
| Json             | string         | 返回token数据对象 |

### 5.2

**说明：HR** **系统获取所有新增/** **更新员工信息接口**

调用：

| **调用URL** | https://hr.meland.com.cn:8099/*thirdPlatformForeign/call/v2/{callmethod} |
| ----------------- | ----------------------------------------------------------------------------- |

入参：

| **参数名** | **类型** | **说明**                                                                                                                                         | **备注** |
| ---------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------ | -------------- |
| json             | String         | 请求参数，json格式字符串，如： { “paramStr”:{“interfaceCode”:”{callmethod} ”}, “tokenStr”:{“clientId”:”XXXXXX”,”token”:”XXXXXX”} } |                |

出参：

| **参数名** | **类型** | **说明**                                                                                                                                                                                                                  |
| ---------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Json             | string         | 当前HR系统内所有员工信息，如： { “code”:200, “data”:[ { “工号”:”XXXX”, “姓名”:”XXXX”, “组织编码”:”XXXX”, “手机号”:”XXXX”, “性别”:”XXXX”, “证件号码”:”XXXX”, “修改日期”:”XXXX”, …… }, …… ] } |

### 5.3

**说明：HR****系统获取离职员工信息接口**

调用：

| **调用URL** | https://hr.meland.com.cn:8099/*thirdPlatformForeign/call/v2/{callmethod} |
| ----------------- | --------------------------------------------------------------------------- |

入参：

| **参数名** | **类型** | **说明**                                                                                                                                        | **备注** |
| ---------------- | -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| json             | String         | 请求参数，json格式字符串，如： { “paramStr”:{“interfaceCode”:”{callmethod} ”, “tokenStr”:{“clientId”:”XXXXXX”,”token”:”XXXXXX”} } |                |

出参：

| **参数名** | **类型** | **说明**                                                                                                                                                                                                                                         |
| ---------------- | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| Json             | string         | 当前HR系统内所有员工信息，如： { “code”:200, “data”:[ { “工号”:”XXXX”, “姓名”:”XXXX”, “组织编码”:”XXXX”, “手机号”:”XXXX”, “性别”:”XXXX”, “证件号码”:”XXXX”, “修改日期”:”XXXX”, “员工状态”:”XXXX”, …… }, …… ] } |

### 5.4

**说明：中控员工数据新增接口**

调用：

| **调用URL** | http://120.79.153.88:8189/api/v2/employee/update/?key=XXXXXX |
| ----------------- | ---------------------------------------------------------------- |

入参：

| **参数名** | **类型** | **说明**                                                                                                                                                                                      | **备注** |
| ---------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| Json             | String         | 员工信息列表，如： [ { “pin”:”工号”, “name”:”姓名”, “deptnumber”:”组织编码”, “mobile”:”手机号”, “gender”:”性别”, “identitycard”:”证件号码”, “xgrq”:”修改日期” }, …… ] |                |

出参：

| **参数名** | **类型** | **说明**       |
| ---------------- | -------------- | -------------------- |
| Json             | string         | 新增员工信息反馈数据 |

### 5.5

**说明：中控系统获取考勤数据接口**

调用：

| **调用URL** | http://120.79.153.88:8189/api/v2/transaction/get/?key=XXXXXX |
| ----------------- | ---------------------------------------------------------------- |

入参：

| **参数名** | **类型** | **说明**                                                                                        | **备注** |
| ---------------- | -------------- | ----------------------------------------------------------------------------------------------------- | -------------- |
| Json             | String         | 员工打卡信息列表，如： { “starttime”:”2023-01-31 09:00:00”, “endtime”:”2023-01-31 23:59:59” } |                |

出参：

| **参数名**                                | **类型** | **说明**                                                                                                      |
| ----------------------------------------------- | -------------- | ------------------------------------------------------------------------------------------------------------------- |
| Json                                            | string         | 员工打卡信息列表，如： { “data”:{ “count”:”2000”, “items”:[ { “pin”:”10001”, “checktime”:”2023-02-01 |
| 09:05:15”, “alias”:”address” }, …… ] } } |                |                                                                                                                     |

### 5.6

**说明：HR****系统员工考勤数据新增接口**

调用：

| **调用URL** | https://hr.meland.com.cn:8099/third/api |
| ----------------- | ------------------------------------------- |

入参：

| **参数名** | **类型** | **说明**                                                                                                                                                                                                                                                                                | **备注** |
| ---------------- | -------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------- |
| json             | String         | 请求参数，json格式字符串，如： { “body”:{ “empOrders”:[ “cardData”:{ “empRule”:”1”, “empKey”:”” , “cardTime”:”” , “dataSource”:”” , “signPlace”:”” , “status”:”” , “longitude”:”” , “latitude”:”” , “describe”:”” , “timeZone”:”” }, …… ] } } |                |

出参：

| **参数名** | **类型** | **说明**           |
| ---------------- | -------------- | ------------------------ |
| Json             | string         | 同步员工考勤数据反馈结果 |

# 6.实施内容

## 6.1 概况描述

将HR系统中最近新增或修改的员工信息即时同步到考勤中控系统中，再由中控系统将新增或修改的员工信息分别下发到员工所属门店考勤机中，以便员工可以即时使用考勤系统，开始后续工作。

员工考勤数据也将通过定时任务，同步到HR系统存储，后期用作考勤统计，工资结算等业务。

## 6.2 程序初始化

### （1）模块名称：程序初始化

### （2）模块路径：HR与中控平台数据同步程序

### （3）逻辑描述：

1：在程序执行任务前，需要对执行任务中的参数（任务执行间隔时长，最近数据时间范围，同步数据字段等）进行配置；

2：程序运行时将新定时任务（HR系统新增/更新数据到中控平台，HR系统离职人员数据到中控平台，中控平台考勤数据到HR系统）来间隔执行数据同步任务；
2.1 ：创建定时任务，用于调用HR系统中新增/更新数据同步中控平台任务；
2.1.1：循环执行数据同步任务，每次任务间隔为预配置小时；
2.1.2：首先通过HR系统接口（接口5.1），生成获取数据时所需要的token信息；
2.1.3：其次用token信息验证权限，获取所有员工信息列表（接口5.2）；
2.1.4：然后循环所有员工信息，判断员工信息的最后修改时间是否在最近预配置小时以内；如果修改时间在预配置小时内，则将该员工信息(员工号，姓名，组织编码，手机号，性别)加到需要同步数据列表中进行组包（最多200个员工信息为一个数据包），如果修改时间在预配置小时以前，则该员工数据的则不添加到同步数据列表中；
2.1.5：最后将已经组好的数据包，循环通过接口（（接口5.4））同步数据包到中控平台中，中控平台收到同步数据之后，再将数据分别下发到员工所属门店考勤设备中；
2.1.6：此时一次数据同步将完成，将等待下一次同步时间，开始下一次同步操作（重新执行2.1.2 - 2.1.5步）。

2.2 ：创建定时任务，用于调用HR系统已离职员工数据同步中控平台任务；
2.2.1：循环执行数据同步任务，每次任务间隔为预配置小时；
2.2.2：首先通过HR系统接口（接口5.1），生成获取数据时所需要的token信息；
2.2.3：其次用token信息验证权限，获取指定时间点后的员工信息列表（接口5.3）；
2.2.4：判断获取员工信息数据返回代码，当代码不为“200”则获取失败；
2.2.5：然后循环所有员工信息，判断状态为“离职”，且用“员工号”逐一查询“中控平台”中员工数据不存在；
2.2.6：最后将通过接口（接口5.4）同步数据包到中控平台中，中控平台收到同步数据之后，再将离职员工从所属门店考勤设备中移除；
2.2.7：此时一次数据同步将完成，将等待下一次同步时间，开始下一次同步操作（重新执行2.2.2 - 2.2.5步）。

2.3 ：创建定时任务，用于调用考勤数据同步HR系统平台任务；
2.3.1：循环执行数据同步任务，每次任务间隔为预配置小时；
2.3.2：首先通过考勤系统的接口（接口5.5），获取到指定时间范围内的考勤数据列表（数据开始时间为系统当前预配置小时之内）；
2.3.3：其次通过HR系统接口（接口5.1），生成获取数据时所需要的token信息；
2.3.4：其后判断token信息验证权限成功，循环所有考勤数据列表；
2.3.5：循环当前获取到的所有考勤数据，提取考勤数据中所需的字段，并将其组成同步到HR系统平台的数据包；
2.3.6：最后将已经组好的数据包，一次性通过HR系统接口（接口5.6）请求发送到HR系统中，接口将返回数据接收后的结果；
2.3.7：此时一次数据同步将完成，将等待下一次同步时间，开始下一次同步操作（重新执行2.3.2 - 2.3.5步）。

3：手动同步指定时间范围（精确到天）考勤数据；
3.1：首先通过考勤系统的接口（接口5.5），获取到指定时间范围内的考勤数据列表；
3.2：其次通过HR系统接口（接口5.1），生成获取数据时所需要的token信息；
3.3：其后判断token信息验证权限成功，循环所有考勤数据列表；
3.4：循环当前获取到的所有考勤数据，提取考勤数据中所需的字段，并将其组成同步到HR系统平台的数据包；
3.5：最后将已经组好的数据包，一次性通过HR系统接口（接口5.6）请求发送到HR系统中，接口将返回数据接收后的结果；
3.6：此时一次数据手动同步完成，程序将退出手动同步任务。