Sync Agent

Automatically synchronize attendance data from ZKTeco biometric devices to AttendUX cloud.

User Guide Sync Agent

Overview

The AttendUX Sync Agent is a lightweight Windows desktop application that bridges your local ZKTeco biometric devices with the AttendUX cloud platform.

It runs in the background, periodically pulling attendance records from your ZKTeco devices and uploading them to your AttendUX server automatically.

Tip: The Sync Agent only needs to be installed on ONE computer that is on the same local network as your ZKTeco devices.

Download & Install

Download the Sync Agent installer and follow the setup wizard:

1

Download the Installer

Download the latest version of the Sync Agent: Download Attendux-Sync-Agent.exe

2

Run the Installer

Double-click the downloaded file and follow the installation wizard. Accept the default settings.

3

Launch the Agent

After installation, the Sync Agent will start automatically. You'll see its icon in the system tray.

AttendUX Sync Agent — Setup

AttendUX Sync Agent

v2.1.0 · Windows Desktop

Installation Complete!
Launch Agent
Close
Screenshot: Sync Agent installer

Configuration

Configure the Sync Agent with your server details and device information:

Field Description Example
Server URLYour AttendUX server addresshttps://yourcompany.attendux.com
Company CodeYour unique company identifierCOMP-001
API KeyAuthentication key from Settings → Integrationssk_live_xxx...
Sync IntervalHow often to sync data (in minutes)5
Device IPLocal IP address of the ZKTeco device192.168.1.201
AttendUX Sync Agent — Config
Configuration
https://company.attendux.com
COMP-001
sk_live_xxxxxxxxxxxxx
192.168.1.201
5 min
Connected · Last sync: 2 min ago
Save & Sync Now
Screenshot: Sync Agent configuration

How Sync Works

The sync process follows these steps automatically:

1

Connect to Device

The agent connects to your ZKTeco device over the local network using TCP/IP.

2

Fetch New Records

It retrieves all new attendance punch records since the last sync.

3

Upload to Cloud

Records are securely sent to your AttendUX server via HTTPS and matched to employees automatically.

Tip: The Sync Agent keeps a local log of all sync operations. Check the Logs tab if you suspect missed records.

Running as a Service

For maximum reliability, you can configure the Sync Agent to run as a Windows service so it starts automatically when the computer boots.

Open the Sync Agent settings and enable "Run as Windows Service". This ensures syncing continues even when no user is logged in.

Warning: The computer running the Sync Agent must remain powered on and connected to the same network as the ZKTeco devices.

Troubleshooting

Common sync issues and how to fix them:

Cannot Connect to Device

Verify the device IP is correct, ensure the device is powered on, and check that the computer and device are on the same network. Try pinging the device IP.

No Data Being Synced

Ensure the API key is correct and not expired. Check that the server URL includes https://. Verify the device has new attendance records.

Duplicate Records Appearing

The agent has built-in deduplication. If duplicates appear, clear the agent cache and re-sync. Check that only one instance of the agent is running.