---
title: "Quick Start Guide"
slug: "γρήγορος-οδηγός-εκκίνησης"
updated: 2026-06-04T11:39:00Z
published: 2026-06-04T11:39:00Z
canonical: "docs.entersoft.eu/γρήγορος-οδηγός-εκκίνησης"
---

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.entersoft.eu/llms.txt
> Use this file to discover all available pages before exploring further.

# Quick Start Guide

---

The **ES1 WorkLife Agent** application is a background Windows service that integrates with EntersoftOne's WorkLife solution for uploading employee attendance data from time-tracking devices to the WorkLife Payroll system. This ensures accurate and efficient transfer of attendance records, enabling seamless workforce management and smooth payroll processing.

It replaces the existing **ESTimeAttendance** service and will overall cover the following integration requirements:

- **ZK Teco:** SDK v2.4.2, PUSH/PULL modes, upload user info, retrieve logs, optional time sync | *released*
- **Hundure:** Connect via API/SDK, migrate existing functionality | *to be delivered*
- **HRMaster:** Download company/employee data, upload attendance data | *to be delivered*
- **File System Mode:** Read/Parse files, upload data | *to be delivered*
- **Database Mode:** Support MySQL/SQL Server/Oracle, secure connections | *to be delivered*

Currently, the following instructions apply only to the integration with **ZKTeco** clocks.

---

## Prerequisites

### System Requirements:

- Windows 10 or later, or Windows Server 2016 and later
- At least 4 GB of RAM
- At least 500 MB of free disk space
- Administrator privileges for installation

Appropriate [firewall settings](/worklife/docs/en/γρήγορος-οδηγός-εκκίνησης#firewall-configuration) configuration is also required.

---

## Installation

1. Download and run the installation file from [here](https://github.com/andreasVelo/es1-worklife-agent).
2. Enter the API Key issued in your Cloud Store account. Instructions can be found [here](https://docs.entersoft.eu/worklife/docs/en/clock-connector-to-entersoft-worklife).
3. Complete the installation process.

The default installation folder is: `Program Files\ES1WorklifeAgent`

---

## Connecting a Time Attendance Device

On a ZKTeco device:

1. Go to the **Communication** menu.
2. Select **Cloud Server**.
3. Enter the IP address of the computer where the agent is installed.
4. Set the port to **8081**.
5. Use **HTTP** (HTTPS is not currently supported).

---

## Displaying Device Information

1. Open the file **ES1.Worklife.Cli.exe** with administrator privileges from the installation folder.
2. Type the command:

```plaintext
devices --info
```

All connected devices will be displayed.

---

## Device Registration

1. Add the device in **WorkLife Payroll**. Instructions can be found [here](https://docs.entersoft.eu/worklife/docs/en/15-04-02-%CF%83%CF%84%CE%B1%CE%B8%CE%BC%CE%BF%CE%AF-%CF%89%CF%81%CE%BF%CE%BC%CE%AD%CF%84%CF%81%CE%B7%CF%83%CE%B7%CF%82).
2. Run the command:

```plaintext
devices 1 --state
```

where `1` is the device number.
3. Use the arrow keys to select the **"Active"** status, after the device has been registered in WorkLife.

The device is now ready to receive attendance events and send them to the WorkLife system.

---

## Basic Commands

| Command | Description |
| --- | --- |
| `install` | Installs the agent as a Windows service |
| `uninstall` | Uninstalls the service |
| `start` | Starts the service |
| `stop` | Stops the service |
| `restart` | Restarts the service |
| `status` | Displays the current status of the service |
| `job` | Job management (use `--help` for more options) |
| `update` | Checks for and installs available updates |
| `db` | Database management tools (use `--help`) |
| `devices` | Device management (use `--help`) |
| `events --info` | Displays an events summary |
| `config` | Edit runtime settings |
| `help` | Displays CLI help |
| `quit` or `q` | Exit interactive CLI mode |

For most commands, you can use the `--help` parameter for additional information.

---

## Device Status and State

### Device Status

| Status | Description |
| --- | --- |
| **Online** | The device is accessible over the network |
| **Offline** | The device is not responding or is turned off |
| **Error** | A communication error has occurred – log files need to be checked |

> Device status is read-only.

### WorkLife Connection State

| State | Description |
| --- | --- |
| **Active** | The device is registered in WorkLife and is exchanging data |
| **Inactive** | Not registered or no active connection |
| **Suspended** | The device has been suspended for maintenance or management purposes |
| **Test** | The device is operating in test mode |

> This state determines how the device communicates with the WorkLife system.

---

## Firewall Configuration

For the correct operation and communication of the ES1 WorkLife Agent with connected devices, the following ports must be open:

| Port | Service | Protocol | Direction | Description |
| --- | --- | --- | --- | --- |
| **8081** | ES1 Worklife Agent (Cloud Server) | HTTP/TCP | Inbound | Allows ZKTeco devices to connect to the agent and transmit attendance events |
| **4370** | ZKTeco Device Communication | TCP/UDP | Outbound | Allows the agent to communicate with ZKTeco devices for polling and data synchronization |