Service Design Specification

workforceos-attendancemanagement-service documentation Version: 1.0.5

Scope

This document provides a structured architectural overview of the attendanceManagement microservice, detailing its configuration, data model, authorization logic, business rules, and API design. It has been automatically generated based on the service definition within Mindbricks, ensuring that the information reflects the source of truth used during code generation and deployment.

The document is intended to serve multiple audiences:

Note for Frontend Developers: While this document is valuable for understanding business logic and data interactions, please refer to the Service API Documentation for endpoint-level specifications and integration details.

Note for Backend Developers: Since the code for this service is automatically generated by Mindbricks, you typically won’t need to implement or modify it manually. However, this document is especially valuable when you’re building other services—whether within Mindbricks or externally—that need to interact with or depend on this service. It provides a clear reference to the service’s data contracts, business rules, and API structure, helping ensure compatibility and correct integration.

AttendanceManagement Service Settings

Handles employee attendance logging (check-in/out), attendance rules (lateness/absence/early-leave), real-time & historical logs, and publishes notification events. Enforces company data isolation, strict record uniqueness, and one-per-shift attendance rule.

Service Overview

This service is configured to listen for HTTP requests on port 3002, serving both the main API interface and default administrative endpoints.

The following routes are available by default:

The service uses a PostgreSQL database for data storage, with the database name set to workforceos-attendancemanagement-service.

This service is accessible via the following environment-specific URLs:

Authentication & Security

This service requires user authentication for access. It supports both JWT and RSA-based authentication mechanisms, ensuring secure user sessions and data integrity. If a crud route also is configured to require login, it will check a valid JWT token in the request query/header/bearer/cookie. If the token is valid, it will extract the user information from the token and make the fetched session data available in the request context.

Service Data Objects

The service uses a PostgreSQL database for data storage, with the database name set to workforceos-attendancemanagement-service.

Data deletion is managed using a soft delete strategy. Instead of removing records from the database, they are flagged as inactive by setting the isActive field to false.

Object Name Description Public Access Tenant Level
attendanceRecord Records a specific user's attendance for a shift (check-in/out), with status (present, absent, late, leftEarly, pending), lateness minutes, absence reason, and manager/admin notes. Enforces strict uniqueness (one record per user per shift per day) and company-level data isolation. accessPrivate Yes

attendanceRecord Data Object

Object Overview

Description: Records a specific user's attendance for a shift (check-in/out), with status (present, absent, late, leftEarly, pending), lateness minutes, absence reason, and manager/admin notes. Enforces strict uniqueness (one record per user per shift per day) and company-level data isolation.

This object represents a core data structure within the service and acts as the blueprint for database interaction, API generation, and business logic enforcement. It is defined using the ObjectSettings pattern, which governs its behavior, access control, caching strategy, and integration points with other systems such as Stripe and Redis.

Core Configuration

Composite Indexes

The index also defines a conflict resolution strategy for duplicate key violations.

When a new record would violate this composite index, the following action will be taken:

On Duplicate: throwError

An error will be thrown, preventing the insertion of conflicting data.

Properties Schema

Property Type Required Description
userId ID Yes Referenced user (employee)
shiftId ID Yes Related shift
checkInTime Date Yes User check-in timestamp (set on check-in)
checkOutTime Date No User check-out timestamp (set on check-out)
status Enum Yes Attendance status: present, absent, late, leftEarly, pending (checked in, not yet out)
lateByMinutes Integer No How many minutes late (if late)
absenceReason String No Reason for absence (manager-provided, e.g., sick, leave)
managerNote Text No Manager/admin note (optional for manual absence management)
companyId ID Yes An ID value to represent the tenant id of the company

Default Values

Default values are automatically assigned to properties when a new object is created, if no value is provided in the request body. Since default values are applied on db level, they should be literal values, not expressions.If you want to use expressions, you can use transposed parameters in any business API to set default values dynamically.

Constant Properties

userId shiftId checkInTime companyId

Constant properties are defined to be immutable after creation, meaning they cannot be updated or changed once set. They are typically used for properties that should remain constant throughout the object’s lifecycle. A property is set to be constant if the Allow Update option is set to false.

Auto Update Properties

checkInTime checkOutTime status lateByMinutes absenceReason managerNote

An update crud API created with the option Auto Params enabled will automatically update these properties with the provided values in the request body. If you want to update any property in your own business logic not by user input, you can set the Allow Auto Update option to false. These properties will be added to the update API’s body parameters and can be updated by the user if any value is provided in the request body.

Enum Properties

Enum properties are defined with a set of allowed values, ensuring that only valid options can be assigned to them. The enum options value will be stored as strings in the database, but when a data object is created an addtional property with the same name plus an idx suffix will be created, which will hold the index of the selected enum option. You can use the index property to sort by the enum value or when your enum options represent a sequence of values.

Elastic Search Indexing

userId shiftId checkInTime status lateByMinutes absenceReason companyId

Properties that are indexed in Elastic Search will be searchable via the Elastic Search API. While all properties are stored in the elastic search index of the data object, only those marked for Elastic Search indexing will be available for search queries.

Database Indexing

userId shiftId status companyId

Properties that are indexed in the database will be optimized for query performance, allowing for faster data retrieval. Make a property indexed in the database if you want to use it frequently in query filters or sorting.

Cache Select Properties

userId shiftId

Cache select properties are used to collect data from Redis entity cache with a different key than the data object id. This allows you to cache data that is not directly related to the data object id, but a frequently used filter.

Secondary Key Properties

userId shiftId companyId

Secondary key properties are used to create an additional indexed identifiers for the data object, allowing for alternative access patterns. Different than normal indexed properties, secondary keys will act as primary keys and Mindbricks will provide automatic secondary key db utility functions to access the data object by the secondary key.

Relation Properties

userId shiftId

Mindbricks supports relations between data objects, allowing you to define how objects are linked together. You can define relations in the data object properties, which will be used to create foreign key constraints in the database. For complex joins operations, Mindbricks supportsa BFF pattern, where you can view dynamic and static views based on Elastic Search Indexes. Use db level relations for simple one-to-one or one-to-many relationships, and use BFF views for complex joins that require multiple data objects to be joined together.

The target object is a sibling object, meaning that the relation is a many-to-one or one-to-one relationship from this object to the target.

On Delete: Set Null Required: Yes

The target object is a sibling object, meaning that the relation is a many-to-one or one-to-one relationship from this object to the target.

On Delete: Set Null Required: Yes

Filter Properties

userId shiftId status companyId

Filter properties are used to define parameters that can be used in query filters, allowing for dynamic data retrieval based on user input or predefined criteria. These properties are automatically mapped as API parameters in the listing API’s that have “Auto Params” enabled.

Business Logic

attendanceManagement has got 5 Business APIs to manage its internal and crud logic. For the details of each business API refer to its chapter.

Edge Controllers

triggerCronMarkAbsentees

Configuration:

REST Settings:

Service Library

Functions

calculateLateness.js

module.exports = function calculateLateness(shift, checkInTime) {
  if (!shift || !shift.startTime || !checkInTime) return {isLate: false, lateByMinutes: 0};
  const shiftStart = new Date(shift.shiftDate + 'T' + shift.startTime);
  const checkIn = new Date(checkInTime);
  const diffMs = checkIn - shiftStart;
  const lateByMinutes = Math.max(Math.round(diffMs / 60000), 0);
  return {
    isLate: diffMs > 0,
    lateByMinutes: diffMs > 0 ? lateByMinutes : 0
  };
};

calculateLeftEarly.js

module.exports = function calculateLeftEarly(shiftEndTime, checkOutTime) {
  if (!shiftEndTime || !checkOutTime) return {leftEarly: false};
  // parse to Date objects assuming checkOutTime has full ISO string
  const shiftEnd = new Date(shiftEndTime);
  const checkOut = new Date(checkOutTime);
  return { leftEarly: checkOut < shiftEnd };
};

cronMarkAbsentees.js

module.exports = async function cronMarkAbsentees(context) {
  /**
   * This cron will:
   * 1. For today's date, for all shifts, fetch all assigned users (assignedUserIds)
   * 2. For each (user, shift) pair: check if an attendanceRecord exists
   * 3. If not, create attendanceRecord with status = 'absent', set shiftId/userId
   */
  const today = new Date().toISOString().slice(0, 10); // YYYY-MM-DD
  const { fetchRemoteListByMQuery, createAttendanceRecord, getAttendanceRecordByQuery } = require('serviceCommon');
  // 1. Fetch all shifts for today, active only
  const shifts = await fetchRemoteListByMQuery('scheduleManagement:shift', { shiftDate: today, isActive: true }, 0, 9999);
  for (const shift of shifts) {
    // resolve all assigned userIds
    const assignedUserIds = shift.assignedUserIds || [];
    for (const userId of assignedUserIds) {
      // Check if attendanceRecord exists
      const existing = await getAttendanceRecordByQuery({ userId, shiftId: shift.id, isActive: true });
      if (!existing) {
        await createAttendanceRecord({ userId, shiftId: shift.id, status: 'absent' }, context);
        // optionally: publish notification event for absentee here
      }
    }
  }
};

Edge Functions

triggerCronMarkAbsentees.js

module.exports = async (request) => {
  const { cronMarkAbsentees } = LIB;
  await cronMarkAbsentees(request);
  return { status: 200, message: 'Processed absentee auto-marking' };
};

This document was generated from the service architecture definition and should be kept in sync with implementation changes.