Home

Biometric Attendance Sync Tool Wiki

The tool is cross-platform by nature but we've made wrappers for Windows services so that they can be installed with relative ease.

Prerequisites:

System:

• Python 3.6+
• Internet connection for requirements setup

Setup:

• API Secret*
• API Key*

*Note: Both generated in your ERPNext instance. Check ERPNext docs for reference.

Configuring ERPNext Biometric Sync Tool:

You can use either methods according to your requirements or preference.

GUI:

• Download and extract the files from the Test Release Link to a dedicated folder
• Change to the working directory under the said folder and run the executable
• Wait for the dependencies to get installed after which the GUI* window will appear
• Fill the required fields
• Set the Configuration files
• Click on Start Service

CLI:

• Fill in the template file with the same information.
• Rename the file, removing the tailing .template and run the files as specified in the README

Where will I find the API key and secret?

• For API key and secret, you need to first login to your ERPNext Site as Administrator.
• Go to My Settings via Settings at the top right corner.
• Go to the API Access section and click on Generate Keys.
• Pop up will appear showing your API secret. Copy your API Secret.
• After that reload the page and go to the API Access section, there you will find your API key.

What are Pull Frequency, Import Start Date, and shift:

• Pull Frequency is the Period (in minutes) after which your software tries to fetch data. It allows the user to fetch the data after the Import strat date.
• The Shift is the Shift type defined in your ERPNext instance