Connect a biometric device

How the sync works

The OneHRIS Agent runs on a local PC connected to your biometric devices. It reads punches from the device and pushes them to OneHRIS with an API key. The punches appear in the portal as attendance records. See review attendance logs.

Generate an API key

1. Go to Settings and open Biometric Sync API Keys.
2. Under Generate New Key, enter a Key Label that says which machine or device the key belongs to, such as "Main Office Agent".
3. Select Generate Key.
4. Copy the key from the warning box. It is not shown again.

The Active Keys list shows each key's name, prefix, when it was last used and when it was created.

Install and configure the agent

The Setup Instructions beside the key list describe the steps. If you do not have the agent installer yet, ask your OneHRIS contact for it.

1. Install OneHRIS Agent on the local PC connected to your biometric devices.
2. Open appsettings.json in the agent folder and set BaseUrl to your company's OneHRIS address and ApiKey to the key you copied.
3. Add one or more sources in the Sources array: a ZKTeco TCP device, an Access database or a SQL database.
4. Start the agent service.

Assign biometric codes to employees

1. Open the employee record, select Actions, then Edit Employee. The Biometric Code field is in Personal Information.
2. Enter the Biometric Code that the device uses for that employee, such as the employee's ID on the device.
3. Save.

Check that punches arrive

After the agent starts, check that Last Used on the key changes from Never. Then open Time, then Attendance Logs, and look for the employee's records. If a record is missing, see fix missing or wrong time logs and duplicate biometric punches.

Revoke a key

If a PC is replaced, lost or taken out of service, select Revoke on its key and confirm. Any agent using the key stops syncing immediately. Generate a new key for the replacement.