Solavel Docs
English

Device Connect: overview

Last updated

SolaHR Device Connect is the part of SolaHR that talks to attendance terminals (fingerprint, face, palm and card readers) so that punches become attendance without anyone typing them in. This page explains, in plain words, how the pieces fit together, which ways of connecting exist and what SolaHR keeps (and never keeps) from your devices.

Read this first: Device Connect is a preview. The Windows connector is not code-signed yet. It has been tested against simulators and against one real terminal, a ZKTeco iFace702 (firmware Ver 6.60 Sep 10 2019), where connecting, reading users and importing punches worked. Every other model is "expected to work" or "not tested", and every feature that goes beyond reading depends on the model and firmware. Start with one device, check the result, then roll out. The honest status of each model is on Supported devices.

#The guide, page by page

You want to... Read
Understand the idea This page
Install the connector on a Windows PC Install the connector
Add a terminal and test it Add a device
Use the ZKTeco SDK (only if you need it) Vendor SDK setup
Link device users to employees, see how punches become attendance Mapping and attendance
Edit users on the terminal, sync its clock, restart it Manage devices
Check whether your model is listed, and find the manufacturer's manual Supported devices
Fix a problem Troubleshooting and FAQ

The screens themselves (device list, device users, review, import) are described in Attendance devices.

#How it works in plain words

 Terminal at the door  <--- office network --->  Connector (a small program on a Windows PC)
                                                         |
                                                         |  HTTPS, outbound only
                                                         v
                                                      SolaHR  --->  Attendance, reports, payroll
  1. The terminal records each scan (a face, a finger, a card, a PIN) together with the person's code on the device and the time.
  2. The connector is a small Windows program that you install on a PC or server in the same network as the terminals. It asks each terminal for new punches every minute or so and sends them to SolaHR. It only makes outbound connections to SolaHR, so you do not open any port towards your office network.
  3. SolaHR matches the device code to an employee (the mapping), and writes the day into attendance, with the same lateness, overtime and review rules as any other check-in.

If the connector PC is off or loses its network, nothing is lost. The terminal keeps its log and the connector keeps what it has already read; both are sent when things are back. (A terminal's log has a limited size, so do not leave a device unread for months.)

#Four ways to connect a terminal

Pick the way that fits the device and your network. In SolaHR these appear as tabs when you add a device.

Way How punches arrive You need Best when
Direct, through the connector The connector reads the terminal over your local network. A Windows PC with the connector, and the terminal's IP address (and Comm Key if it has one). The terminal is on the office network. This is the main, best-tested route.
Through the manufacturer's SDK The connector uses the manufacturer's Windows software to read the terminal. The same, plus the manufacturer's SDK installed on that PC. Today: ZKTeco only. You need things the direct route cannot do, such as live events, enabling/disabling users or copying faces and fingerprints. See Vendor SDK setup.
Push (ADMS and similar) The terminal sends each punch to a web address that SolaHR shows you. The terminal's server/cloud setting pointed at SolaHR, and the device registered in SolaHR first. No PC. The terminal supports it and the PC route is not possible. Some push devices also need your administrator to allow the device on the web server.
Cloud or server service SolaHR (or the connector) reads the punches from the manufacturer's own server or cloud account. An account on that service: Suprema BioStar 2 server, Anviz CrossChex Cloud. The devices already report to that service.

There are also two connection-free choices: File import (upload a CSV, TXT or DAT export from the terminal) and a folder watcher that imports files dropped into a folder. They need no installation and work with almost any terminal. See Import a punch file.

A note on honesty: for every route, the level shown in SolaHR is the real one. Planned cannot be chosen yet, Software-tested means tested against simulators, Hardware-verified means tested on a real device.

#What SolaHR stores, and what it never stores

Stored in SolaHR Never stored in SolaHR
The device record: name, location, model, firmware, serial number, IP address and port Fingerprints, face templates and palm templates
The Comm Key or device password, encrypted and never shown again Passwords of device users (a new password you type is sent to the device and not kept)
Device users: code, name, card number, role, and whether a face, fingerprint or password exists (a yes/no, not the data) Raw biometric data of any kind: if a device ever sent it, SolaHR refuses it
Every punch: device code, time, direction, method (face, fingerprint, card, password)
The snapshot photo some terminals take at a punch, kept privately and shown only to people who may see both attendance and employees
The audit log of every change made to a device and who made it

The connector PC itself keeps the pairing token and device Comm Keys encrypted, and punches that have not been sent yet. Copying a face or fingerprint from one terminal to another goes terminal to connector to terminal and never reaches SolaHR. See Manage devices.

#Who can do what

Action Permission
See devices, mappings, activity and imports View attendance
Add and edit devices and connectors, test, map, push or edit users, import Manage attendance devices... (Owner and HR Manager)
Set the device clock, restart a device, copy faces/fingerprints, give a device user a role above User Run advanced device commands, Owner only

Details and the exact wording are on Attendance devices.

#Limits to keep in mind

  • Preview software; the installer is unsigned and Windows will warn you.
  • Windows 10/11 or Windows Server 2016 and later, 64-bit only, for the connector.
  • Real-time punches are only available on a few connection types; most devices are checked every 1 to 30 minutes.
  • Reading is the safe default. Changes to a device (edit, delete, push, copy) must be allowed on the connector PC as well, and what is possible depends on the connection type and model.
  • Dahua, Uniview and other brands are not in the catalog. Their terminals can still be used through File import or, where they can send punches to a web address, the generic push route.