Integrating Geer ERP With Biometric Attendance Devices

Integrating ERPNext With Biometric Attendance Devices

Background

The biometric device's attendance punch logs serve as an employee's check-in and check-out records. These logs can be kept in an Employee Checkin document, which is a feature of ERPNext.

With Auto Attendance, attendance may then be indicated depending on the employee's shift type and Employee Checkin data.

So, the following procedures can be used to integrate your biometric device (or any other access control system that gathers IN/OUT logs):

1. Setting up Auto Attendance to mark attendance from the Employee Checkin You must configure the workers and their shifts so that ERPNext's Auto Attendance function can generate attendance before you import/sync the workers' check-in and check-out records.

To set up auto attendance, kindly click the following link: Set up Auto Attendance

You are now prepared to go on to the following phase once you have set up the employee master and given the employees their shift assignments.

2. Populating the Biometric Punch Logs into ERPNext's Employee Checkin There are a variety of ways to populate the Punch logs in ERPNext, depending on your biometric system and its functionality.

  1. Use ERPNext's Data Import Tool:
  • The most straightforward option (in terms of implementation complexity) would be to create an Excel/CSV of the check-in/check-out logs and periodically import them into your employee check-in document using the built-in data import function in ERPNext.

  • For additional information on how to do this, please see the Data Import Tool Manual for ERPNext.

  1. API Integration:
  • By integrating it with the accessible API in ERPNext, you can automate the process of syncing the biometric punch logs.

  • There are some technical requirements for this strategy, so you should probably contact your ERPNext implementer or biometric system vendor.

STEPS:

  1. Since this API call requires authentication, you will first need to establish a user in your ERPNext instance who will be used for creating logs. Verify that the user has the necessary rights to create Employee Checkin.

  2. Create the user's API Key and API Secret, which will be used in authentication.

  3. Make sure your biometric device has been used to set the employee's attendance device ID (biometric/RF tag ID).

  4. The API may be accessed at /api/method/erpnext.hr.doctype.employee checkin.employee checkin.add log based on employee field, and the API implementation details are available here.

  5. To submit a POST request to the API, you can create a script. Using the value of the employee field, this endpoint locates the pertinent Employee and generates an Employee Checkin. information about the API endpoint

  • URL: /api/method/erpnext.hr.doctype.employeecheckin.employeecheckin.addlogbasedonemployee_field

  • Method: POST

  • Params:

  • employee field value: The employee field's value to search for. This is the Attendance Device ID that is recorded in both the employee record and your biometric logs.

  • timestamp: The timestamp for the Log. the string "2022-04-08 10:48:08.000000" is what is currently anticipated.
  • device id: (optional) (optional) Device ID and location. A brief string is anticipated.
  • log type: (optional) (optional) if applicable, the punch's direction (IN/OUT).
  • skip auto attendance: (optional) (optional) This log's skip auto attendance field will be set to 0/1.
  • employee fieldname: The name of the field in the Employee DocType on which an employee lookup will be based (default: attendance device id).
  • Returns a document object created for an employee check-in.

3.Set up a python script on your computer to integrate ZKTeco or similar devices: * Only ZKTeco or similar devices that employ the ZKProtocol for TCP/IP communication will function with this manner. * This script is accessible at: github:frappe/push-biometric-erpnext. * Please set it up on your computer by following the instructions provided on the script page. * This script pushes biometric logs into ERPNext using the API indicated in the step above after pulling them from a compatible device.

Frequently Asked Questions

*1. 1. How do I select a Biometric Device which is compatible with ERPNext? *

Concerning compatibility, you don't need to worry if you're utilizing technique 1 or 2.

The push biometric app, however, internally employs a script for the third way that works with the gadgets listed here. Any ZKTeco or comparable device that utilizes the ZKProtocol to communicate over TCP/IP should typically function. In terms of purchasing the device, we advise choosing a device trial with the vendor if at all possible so that the device can be tested with the sync tool. This is because compatibility depends on a number of different aspects.

*2. How do I know which method to use for integrating my biometric device with ERPNext? *

Method 1 can be used in any circumstance, but it necessitates frequent manual log importation. Options 2 and 3 work for a one-time setup for the automated log syncing but require some monitoring.

For a single location set up: The tool must be able to communicate with your biometric device through TCP/IP in order to use the Push Biometric Device method. As a result, it is typically necessary for it to operate on the same LAN Network as the biometric device. It uses API access to sync these downloaded logs to your ERPNext instance. When you have everything set up in one place, this works best.

For a multi-location set up: In this situation, we typically advise way 2, in which the majority of biometric providers offer services to sync biometric device logs from several locations to ERPNext via API access. If you have any networking experience, method 3 (push biometric attendance tool) may also be applicable in this situation.