Attendance Data Auto-Synchronisation

05-Dec-2025 · Wing Au Yeung
Available in other languages 中文

Overview

For the requirements and preparation steps for setting up the automatic synchronisation of attendance data into the HR system, you can choose to synchronise data via direct Database Connection (Option A) or File-based Transfer (Option B).

Option A: Database Synchronisation

This is the preferred method for real-time integration. If you choose a direct connection to your attendance database, please review the following requirements.

1. Required Information

To configure the connection, our team requires the following details regarding your database credentials and structure:

  • Database Login: Username and Password.

  • Database Name: The specific name of the database containing the records.

  • Table Names: The names of the related tables where attendance data is stored.

  • Data Mapping: You must specify which columns in your database correspond to our system's required fields. Please provide the specific column names for:

    • User Identification: User ID, Employee number

    • Check-in Date and Time: Log time, Timestamp)

2. Network and Remote Access

For our system to access your database remotely, your IT team (or internal IT) must take the following actions:

  • Whitelist IP: Whitelist our server's IP address and Port in your firewall settings to allow incoming connections.

  • Connection Details: Provide us with your Server IP (or Hostname) and Port number.

Option B: File-Based Synchronisation (TXT, CSV, Excel)

If you prefer to provide attendance logs via flat files, please ensure the following standards are met.

1. File Format and Content

  • Supported Formats: .txt, .csv, or Excel (.xls, .xlsx).

  • Mandatory Fields: Each data line or record in the file must contain the following information:

    • Placement Number (or User ID/User Number)

    • Check-in Date and Time

2. File Location and Transfer Methods

The source file must be updated regularly in a designated location before the scheduled import time.

2.1: Local / Network Drive
Suitable if the file is stored on a local drive or a shared network drive directly accessible by our import service.

2.2: Remote Transfer (FTP/SFTP)
If the file is hosted remotely, please provide the following connection details to our technical team:

  • Server Details: FTP Server IP (or Domain Name) and Port.

  • Protocol: SFTP (Secure FTP) is highly recommended for data security. Standard FTP is supported but not recommended due to lack of encryption.

  • Credentials: Username and Password.

  • File Path: The exact directory path where the source file is located.

General Requirements

1. Data Integrity & Mapping to Backstage

Regardless of the method chosen (Database or File), the system must be able to link the imported records to the correct personnel in the system.

  • Mapping Key: All attendance records must contain a value (e.g., Placement Number or User ID) that matches an existing Placement Number or Attendance Number in Backstage. Unmapped records may fail to import.

2. Synchronization Schedule

Please determine the preferred daily time(s) for the data synchronization to occur. Ensure that your database records or files are updated and ready before this scheduled time.