ELink Wiki

[TOC]

环境依赖

.NET Core 3.1

Windows Server 2008 R2 SP1 以上

Windows 7 SP1以上

CentOS 7+ x64

Debian 9+ x64

部署于Linux时 连接的数据库版本 要求高于 SqlServer 2008 SP3

.NET Core 3.1 微软系统要求说明：

https://github.com/dotnet/core/blob/main/release-notes/3.1/3.1-supported-os.md

版本更新

详见每次迭代发布

部署与说明

打包为Windows 服务： 在软件根目录找到脚本：Install_Service.bat (安装服务) Uninstall_Service (卸载服务)

主服务ELink

• V5客服端的后台服务 包含V5运行所必须的各项内容。
• 各个微服务的 主服务框架。
• 适用于2021-02 月之后发布版本
• 节点 Connection 修改 MsSql 的数据库连接字符串 ，不可使用本地连接，该连接会分发给客户端用以连接服务器
• 主服务端口默认为8072
• 授权文件在App_Data内（主服务版本1.0.2以上），

关于响应压缩 ：

1. 根据服务器配置选择 修改 appsettings.json 编辑 节点 Startup 修改 CompressionLevel 的值 （0-2），值越小 压缩越严格，占用服务器硬件资源越多，占用带宽越少 建议值为 1

首次打开会自动在浏览器打开主服务的部署地址（如未打开可能被拦截，请手动打开：主服务地址/elinkinstall/），根据流程完成部署

删除根目录下的 end 文件再次打开重新进入部署引导; 如果APIConfig.json内存在参数InstallFinish则需要删除该参数

(目录下存在end 文件 或者 APIConfig.json内参数InstallFinish 为 true 不会进入部署引导)

以下为非必须操作

• [ ] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用 （端口被其他程序占用时才需要修改）

• [ ] 打开 APIConfig.json

  1. 编辑 节点 System 修改 消息推送 为 钉钉 或者 微信 需要发送消息 多个用 | 隔开

启用 https

• [ ] 编辑 appsettings.json ：

  1. 编辑 节点 Startup 修改 ApiUrls 为https地址 如（https://*:443） 多端口 用 ; 隔开各个地址

• [ ] 编辑 APIConfig.json ：

  1. 编辑 节点 System 修改 SSLPath 为 ssl证书文件绝对路径 （ 路径内 \ 需要转义 即 修改为 \\ 例如 E:\\zhengshu.crt）
  2. 编辑 节点 System 修改 SSLPassword 为 ssl证书密钥

• 报错日志在根目录的 Log 文件加内查看

主服务插件

钉钉插件（DingTalkDocking）

集成与主服务中，

签卡回调

如需要使用钉钉签卡回调， （该回调对应钉钉考勤签到应用） 详细见 钉钉回调说明文档

1. 需要在钉钉后台配置 事件订阅，
2. 事件回调地址为 http://ceshi.etiersoft.com:8072/DingTalkDocking/V1/CallBack 域名端口替换为客户的公网地址
3. 并将事件订阅的 aes_key 和 token 填入 主服务的APIConfig.json文件 DingTalk 节点下的 Event_Aes_Key 和 Event_Token
4. 重要 钉钉考勤签到应用 签卡回调不区分外签还是内签 需要设置钉钉不允许再考勤签到内打外签卡

签卡拉取

如需要使用钉钉签卡拉取，

1. 配置主服务内 APIConfig.json 参数 DingTalk=> PullOutRecordInsertToRecord 是否将拉取到的钉钉外签卡写入t_attrecord 默认false；
2. 添加计划任务 http://ceshi.etiersoft.com:8072/DingTalkDocking/V1/Record/Pull 域名端口替换为客户的公网地址
3. 计划任务 每次执行拉取时取上次执行结束时间作为本次的开始时间，
4. 指定开始结束时间 http://ceshi.etiersoft.com:8072/DingTalkDocking/V1/Record/Pull?startDate=2020-02-01&endDate=2020-02-05`
5. 参数 syncInSideRecord 是否将拉取到的钉钉内签卡写入 t_attrecord 默认true;

   参数 syncOutSideRecord 是否将拉取到的钉钉外签卡写入t_attyunrecord 默认true；

   http://ceshi.etiersoft.com:8072/DingTalkDocking/V1/Record/Pull?startDate=2020-02-01&endDate=2020-02-05&syncInSideRecord=true&syncOutSideRecord=true`
6. syncInSideRecord 与 syncOutSideRecord 都为false时 接口将返回拉取到的签卡记录用于排查
7. 参数 deptid （hr部门id）表示只拉取该部门及其子部门的人员签卡http://ceshi.etiersoft.com:8072/DingTalkDocking/V1/Record/Pull?deptid=1

微信插件（WeChatDocking）

集成与主服务中， 需要验证回调域名 将从微信下载的txt文件置于ELink根目录下wwwroot文件夹内即可

签卡拉取

如需要使用微信签卡拉取， 主服务内 APIConfig.json 参数 WeChat=> PullOutRecordInsertToRecord 是否将拉取到的微信外出签卡写入t_attrecord 默认false；

1. 配置主服务内 APIConfig.json 参数 WeChat=> PullOutRecordInsertToRecord 是否将拉取到的微信外出签卡写入t_attrecord 默认false；
2. 配置主服务内 APIConfig.json 参数 WeChat=> RecordAgentId 和 RecordAppSecret 对应微信后台签卡应用的AgentId和Secret；
3. 添加计划任务 http://ceshi.etiersoft.com:8072/WeChatDocking/V1/Record/Pull **域名端口替换为客户的公网地址
4. 计划任务 每次执行拉取时取上次执行结束时间作为本次的开始时间，
5. 指定开始结束时间 http://ceshi.etiersoft.com:8072/WeChatDocking/V1/Record/Pull?startDate=2020-02-01&endDate=2020-02-05`
6. 参数 syncInSideRecord 是否将拉取到的微信内签卡写入 t_attrecord 默认true;

   参数 syncOutSideRecord 是否将拉取到的微信外签卡写入t_attyunrecord 默认true；

   http://ceshi.etiersoft.com:8072/WeChatDocking/V1/Record/Pull?startDate=2020-02-01&endDate=2020-02-05&syncInSideRecord=true&syncOutSideRecord=true`
7. syncInSideRecord 与 syncOutSideRecord 都为false时 接口将返回拉取到的签卡记录用于排查
8. 参数 deptid （hr部门id）表示只拉取该部门及其子部门的人员签卡http://ceshi.etiersoft.com:8072/WeChatDocking/V1/Record/Pull?deptid=1

小微云插件 (CloudDocking)

在三方管理内配置 账号 密码

每7200秒默认为token过期会重新请求token;

同步：将hr内人员部门推送至云端（云端已有则绑定）。 不会将云端头像拉取过来

云端后台如果配置园区回调地址 https://elink公网地址/CloudDocking/V1/CallBack 则表示将云端人员部门的增删改同步至hr（hr内需要有人员部门的绑定关系）

以下为非必须操做

• [ ] 打开APIConfig.json
• 编辑 节点 Cloud 修改 BASE_URL 配置 小微云的接口地址， 不配置默认为 https://v6.etiersoft.com

员工助手 (YunAppService)

提供员工助手的接口

• [x] 打开放置前端文件

1. 将最新的手机前端文件放入ELink 园区服务的 wwwroot文件夹内; 访问地址为 园区服务地址加前端文件夹的名称

   （如文件夹名：HrWeChat 则：ELink地址/HrWeChat ）

• [x] 打开APIConfig.json

1. 编辑 节点 hrwechat 修改 内容 控制手机页面界面； Sort 控制显示顺序 Model 控制显示模块

   注意 节点 hrwechat 为 前端文件的文件夹名小写字母 实际情况根据 放置前端文件时命名的文件夹名称为准

• 编辑 节点 System 修改 DataCenterUrl 配置 计算服务的地址 ，必须为公网地址

企业微信后台配置主页 ： ELink地址+ /WeChatDocking/V1/User/Login

钉钉后台配置主页 ： ELink地址+ /DingTalkDocking/V1/User/Login

如果放置的前端文件夹名不为 HrWeChat 如 命名为 kaoqing 只要显示考勤模块 ：

企业微信后台配置主页 ： ELink地址+ /WeChatDocking/V1/User/Login?returnurl=ELink地址+/kaoqing

钉钉后台配置主页 ： ELink地址+ /DingTalkDocking/V1/User/Login?returnurl=ELink地址+/kaoqing

编辑 节点 kaoqing (自定义的名称需要复制原配置自行修改) 修改 内容 控制手机页面界面； Sort 控制显示顺序 Model 控制显示模块

独立微服务

海康适配器服务（HIKVisionAdapter）

连接海康人脸设备一体机

使用通用部署引导

删除根目录下的 end 文件再次打开重新进入部署引导

海康设备进行计次消费

1. 使用海康设备进行计次消费时，HR内录入 设备类型为考勤门禁机，品牌为海康计次 的设备， 再配置计次设备的消费方案，

门禁记录将进入消费记录内，单时段最多写入次数为消费方案内设定的次数

需要联动校讯通

1. 需要联动校讯通时 需要在 APIConfig.json 的 SiXun 节点内配置 AttPush(是否启用考勤签卡推送) AccessPush(是否启用门禁签卡推送) Token（校讯通学校令牌） ServerUrl（校讯通服务器地址） 目前前端显示 重发等依赖iis中台 仅在业务中排除了物联中台 或者依赖ELink 三方接口内的校讯通模块

需要推送打卡提醒

在 APIConfig.json 的 System 节点内配置 消息推送 (配置需要推送的类型 “微信|钉钉”) 需要将适配器注册至主服务

如需要推送至IIS 在 APIConfig.json 的 IIS 节点内配置 NotifyPush (是否启用推送至IIS) NotifyUrl (IIS中台地址 http://192.168.2.211:8081)

配置文件说明：

• [ ] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

• [ ] 打开APIConfig.json

  1. 编辑 节点 HIKVisionAdapter 修改 UseEnrollNo 配置 false 表示使用EmployeeId做为Pin码
  2. 编辑 节点 HIKVisionAdapter 修改 GardenSdkType 配置 连接的设备接口类型 多个接口用, 隔开， 默认 海康接口 对应V5客户端的设备接口

以下操作需要注意：如果服务器上原本已运行任何 中控软件 ，注册中控sdk 可能导致原有程序报错

1. 注册中控Sdk ：进入适配器目录 > x86 > dll 先运行脚本 Delete_SDK.bat 再运行 install.bat

如果适配器运行报错 请多重试注册Sdk； 如果无效请收集日志

• Pin码默认EmployeeId （根据目录内APIConfig.json内 ZKTPullAdapter 节点 UseEnrollNo 配置 true 表示使用考勤登记号，推荐使用EmployeeId 做为Pin码）
• 下发照片进行压缩到200k以内 系统录入照片时建议大小控制在100~200k之间 不可小于100k 像素点过低无法识别，人脸需要居中于照片， 如果人脸占用照片画面大部分，请尝试手动压缩至200k以内再录入系统
• 读取人事表内卡号
• 人员无卡号时 卡号填充为Pin码
• 连接设备时默认下发一组时间区 00:00 - 23:59 占用设备TimezoneId为1 门号1111 全部门有权限
• 下发人员默认设置权限为，TimezoneId为1
• 访问 适配器地址/ZKTPullAdapter/V1/Driver/SearchMachine 扫描获取局域网内的设备 当前返回Json 数据
• 在V5客户端添加门禁设备 数据由 适配器返回的 Json 内查看，或者使用中控的软件查看

中控Pull适配器（ZKTPullAdapter）

连接中控门禁板

使用通用部署引导

删除根目录下的 end 文件再次打开重新进入部署引导

配置文件说明：

• [ ] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

• [ ] 打开APIConfig.json

  1. 编辑 节点 ZKTPullAdapter 修改 UseEnrollNo 配置 false 表示使用EmployeeId做为Pin码
  2. 编辑 节点 ZKTPullAdapter 修改 GardenSdkType 配置 连接的设备接口类型 多个接口用, 隔开， 默认 物联中台接口 对应V5客户端的设备接口

以下操作需要注意：如果服务器上原本已运行任何 中控软件 ，中控适配器 可能导致原有程序报错

1. 注册中控Sdk ：进入适配器目录 > x86 > dll 先运行脚本 Delete_SDK.bat 再运行 install.bat

如果适配器运行报错 请多重试注册Sdk； 如果无效请收集日志

• Pin码默认EmployeeId （根据目录内APIConfig.json内 ZKTPullAdapter 节点 UseEnrollNo 配置 true 表示使用考勤登记号，推荐使用EmployeeId 做为Pin码）
• 读取人事表内卡号
• 人员无卡号时 卡号填充为Pin码
• 连接设备时默认下发一组时间区 00:00 - 23:59 占用设备TimezoneId为1 门号1111 全部门有权限
• 下发人员默认设置权限为，TimezoneId为1
• 访问 适配器地址/ZKTPullAdapter/V1/Driver/SearchMachine 扫描获取局域网内的设备 当前返回Json 数据
• 在V5客户端添加门禁设备 数据由 适配器返回的 Json 内查看，或者使用中控的软件查看

中控Push适配器（ZKTPushAdapter）

连接中控考勤机 设备内配置服务器地址为本适配器的通讯地址 设备pushver需要大于2.2.14

使用通用部署引导

删除根目录下的 end 文件再次打开重新进入部署引导

配置文件说明：

• [ ] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

• [ ] 打开APIConfig.json

  1. 编辑 节点 ZKTPushAdapter 修改 UseEnrollNo 配置 false 表示使用EmployeeId做为Pin码
  2. 编辑 节点 ZKTPushAdapter 修改 GardenSdkType 配置 连接的设备接口类型 多个接口用, 隔开， 默认 物联中台接口 对应V5客户端的设备接口

设备存储人脸和指纹 为特征码， 新录入人员步骤: 客户端录入信息 > 下发至设备 > 设备上录入人脸 和 指纹 > 采集刚刚下发的人员（采集人脸和指纹）> 下发人员至其他设备

由于存储为特征码 上传再下发后部分人员可能存在识别精度问题，需要在设备设置内调低识别 阈值

• Pin码默认EmployeeId （根据目录内APIConfig.json内 ZKTPushAdapter 节点 UseEnrollNo 配置 true 表示使用考勤登记号，推荐使用EmployeeId 做为Pin码）

1. 读取人事表内卡号
2. 人员无卡号时 卡号填充为Pin码
3. 设备需要刷机升级固件支持 pushver2.2.14 以上才可用于本适配器
4. 指纹特征 和人脸特征存于 t_attfingerprint
5. 设备需要厂家刷机后才能支持 pushver 2.2.14 ！！！！！

微耕适配器（WGAdapter）

连接微耕门禁控制板

使用通用部署引导

删除根目录下的 end 文件再次打开重新进入部署引导

配置文件说明：

• [ ] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

• [ ] 打开APIConfig.json

  1. 编辑 节点 WGAdapter 修改 UseEnrollNo 配置 false 表示使用EmployeeId做为Pin码
  2. 编辑 节点 WGAdapter 修改 GardenSdkType 配置 连接的设备接口类型 多个接口用, 隔开， 默认 易天门禁接口 对应V5客户端的设备接口

微耕设备无Pin码概念，无人员姓名概念， 以卡号为人员标识， 门禁权限下发 仅支持类型 每日 每周 ， 人员通行时间段以周为单位存储

• 读取人事表内卡号
• 人员无卡号时 卡号填充为EmployeeId

松美消费适配器（SongMeiConsumeAdapter）

连接松美消费机 设备内配置服务器地址为本适配器的通讯地址

使用通用部署引导

删除根目录下的 end 文件再次打开重新进入部署引导

机器出厂密码 11223344 进入机器后台 后在《网络配置》内配置《服务器地址》 为适配器的地址

• [x] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

• [x] 打开APIConfig.json

  1. 编辑 节点 SongMeiConsumeAdapter 修改 UseEnrollNo 配置 false 表示使用EmployeeId做为Pin码
  2. 编辑 节点 SongMeiConsumeAdapter 修改 HeartBeatTime 配置 设备心跳的间隔 （注意如果配置过长，只能重置设备来恢复）
• [x] 离线消费

1. 支持离线消费（需要在机器上设置，或者下发参数（园区客户端消费机模块内配置后由指令下发））， 连上服务器后 会将离线记录传给服务器

• [x] 在线消费

1. 消费成功与否由服务器判断 可实现现行消费功能

• [x] 消费记录

1. 在线消费时 直接写入数据库
2. 通过下发设备参数指定恢复最近的消费记录（条数，不支时间范围），要求设备重新上传记录

海康消费适配器（HIKVisionConsumeAdapter）

1. hr消费机管理模块内录入 设备 ip， 账号， 密码， 序列号 ， 品牌填写 海康人脸 端口填写 80
2. 配置appsettings.json(见下方)后启动适配器
3. hr消费机管理用用指令下发人员至设备

• [x] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

• [x] 离线消费

1. 支持离线消费（需要在机器上设置，）， 连上服务器后 会将离线记录传给服务器

• [x] 在线消费

1. 消费成功与否由服务器判断 可实现现行消费功能

• [x] 消费记录

1. 在线消费时 直接写入数据库

• [x] 消费退款

1. 设备点击退款， 验证人脸 ， 输入纠错密码 并确认
2. 设备仅可退款上一笔消费，且不可重复退款，
3. 纠错密码在设备设置内修改，如未设置 不可进行退款操作

浩顺适配器（HSunAdapter）

浩顺设备序列号在设备菜单内的 《云序列号》中查看 ，设备内配置服务器地址为本适配器的通讯地址

使用通用部署引导

删除根目录下的 end 文件再次打开重新进入部署引导

配置文件说明：

• [ ] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

• [ ] 打开APIConfig.json

  1. 编辑 节点 HSunAdapter 修改 UseEnrollNo 配置 false 表示使用EmployeeId做为Pin码

设备存储人脸和指纹 为特征码， 新录入人员步骤: 客户端录入信息 > 下发至设备 > 设备上录入人脸 和 指纹 > 采集刚刚下发的人员（采集人脸和指纹）> 下发人员至其他设备

1. 读取人事表内卡号
2. 人员无卡号时 卡号填充为Pin码
3. 指纹特征 和人脸特征存于 t_attfingerprint

ActiveReport服务（ARReport）

AR报表服务

• 提供客户端 和手机端 的报表支持
• 提供b/s端的报表查看和编辑 账号与客户端账号通用

使用通用部署引导

删除根目录下的 end 文件再次打开重新进入部署引导

配置文件说明：

• [ ] 打开 appsettings.json

  1. 编辑 节点 Startup 修改 ApiUrls 的端口值 该值为程序启动占用的端口，该端口不可以被其他程序使用
  2. 编辑 节点 MicroService 修改 MasterService 的主服务连接地址。 节点内 Enable 值为 false 表示不向主服务注册
  3. 编辑 节点 Connection 修改 MsSql 的数据库连接字符串 （如果配置主服务地址，跳过该步骤，适配器会向主服务请求数据库连接）
  4. 编辑 节点 MicroService 修改 UrlPath 的连接 为本适配器的连接地址。 该链接需要可以让主服务程序访问

工具相关说明

1. IIS微信钉钉同步关系迁移至ELink

   打开ELink根目录，找到目录Tools 找到程序 IIS2ELink.exe 双击运行， 填入老IIS中台数据库连接 和HR数据库连接 点击迁移。 （如无法运行先安装.NetCore3.1 Runtime x64 运行环境）

计划任务 相关说明

计划任务配置字段

需要向钉钉或微信发送执行结果时 需要为任务配置 DingTalk 和 WeChat 参数（参数说明见 计划任务配置字段）

计划任务汇总