User Guide for ERPNext ZKTeco Attendance Integration

ERPNext ZKTeco Attendance Integration connects a ZKTeco device to ERPNext. It brings each punch from the device into ERPNext, so you no longer copy biometric attendance by hand.

HR teams and system managers use it. They add each ZKTeco device, link device users to employees, and read every punch log in one place.

By the end of this guide, you can add a device, receive punches, and check attendance, breaks and sync results.

ERPNext ZKTeco Attendance Integration works in conjunction with the following modules:

ERPNext and HRMS

You must install the above-mentioned modules to use the ERPNext ZKTeco Attendance Integration.

1. Add any number of ZKTeco device records, each with its own address and settings.
2. Pull biometric attendance from a device on a schedule, or sync it at once.
3. Receive punches from remote devices with ADMS Push.
4. Link device users to employees, and enroll employees on a device.
5. Keep every punch log without duplicates.
6. Create an Employee Checkin for each punch.
7. Track employee breaks with their length.
8. Read punches and hours in the attendance reports.
9. Check each sync run and the state of each ZKTeco device.

1. After purchasing the app from Webkul Store, you will receive a link to download the module ZIP file.
2. Extract the ZIP file. You will see a folder named ‘erpnext_zkteco_attendance_integration’.
3. Set up the module in your git repository, then fetch it using:

bench get-app --branch main https://git.webkul.com/erpnext-apps/erpnext_zkteco_attendance_integration.git

(Replace “main” with your branch name and replace the “HTTPS URL” with your HTTPS clone URL.)

4. Install the app on your site:

bench --site <your-site-name> install-app erpnext_zkteco_attendance_integration

5. Run bench migrate to complete the setup.

1. Open the ZKTeco Device list. It shows each device with its connection mode and status.

2. Click Add ZKTeco Device. The new device form opens.

3. Enter the Device Name, IP Address and Port. The default port is 4370.
4. Click Save, then click Test Connection. ERPNext reads the model and serial number of the ZKTeco device.
5. Click Sync Now to pull the punch log from the device.

1. Open ZKTeco Settings. The status panel shows if the library, HRMS and your devices are ready.

2. Tick Enable ADMS Push Mode. Use this when ERPNext cannot reach the device, for example behind a router.

3. On the device, enter your ERPNext address as the cloud server.
4. On the ZKTeco Device form, set Connection Mode to ADMS Push and enter the Serial Number.

1. Open a ZKTeco Device and click the Users menu.
2. Choose Fetch Machine Users to copy the device user list into ERPNext.
3. Choose Enroll Employees to write employees onto the device, or Remove Employees to delete them.

4. Open the ZKTeco Device User list. Each row shows the device user ID and the linked employee.

1. Open the ZKTeco Attendance Log list. It holds every punch log with its device and employee.

2. Open the ZKTeco Attendance Feed report. Filter by date, device or employee.

3. Open the ZKTeco Daily Attendance report. It shows first in, last out, break hours and working hours for each day.

4. Open the ZKTeco Employee Break list to see each break and how long it lasted.

5. Open the ZKTeco Sync Run list to see the result of each sync.

Hope you find this guide helpful! Please feel free to share your feedback in the comments below.

If you still have any issues/queries, please create a ticket at the UV Desk.

I hope this helps. In case of any further queries, contact us at our support mail.

Thanks for paying attention!!