# Attendance
## Overview
The attendance registry allows creation of an attendance register, enrollment of staff and attendees and capture of attendance records with entry/exit times. To compute attendance based on the logs, a calculator service should be built with specific business logic.
## Pre-requisites
* DIGIT backbone services
* Idgen
* Persister
* Project Service
* Boundary Service
## Functionalities
* Allows creation/updation/search of an attendance register
* Allows mapping of staff and attendees to a register and enforces permissions.
* Log entry and exit timestamps in epoch time for a referenced entity
* Staff members can be added or removed from the Attendance Register, with roles (Editor, Approver, Owner) defining permissions: Editors modify records, Approvers validate records, and Owners have full administrative control.
## Setup
{% stepper %}
{% step %}
### Clone or download the code from the GitHub repository
The source code for the Attendance registry is located in the [Git repository here](https://github.com/egovernments/DIGIT-Works/tree/master/backend/attendance). Clone or download the code from this repository before proceeding.
{% endstep %}
{% step %}
### Add the Lombok extension/plugin
The Attendance module is a Spring Boot application that uses Lombok, a Java library. Add the Lombok extension/plugin to open and build the project in your IDE (like IntelliJ or Eclipse).
{% endstep %}
{% step %}
### Setup Lombok in IDEs
Install the Lombok plugin directly from the IntelliJ plugins marketplace.
* Download the Lombok jar file.
* Add the following line to your `eclipse.ini` file (replace `lombok.jar` with the correct path to your Lombok jar):
```
-javaagent:lombok.jar
```
{% endstep %}
{% step %}
### Run application
Once Lombok is set up and the application is running (using your IDE or command line), you can start making API requests to the Attendance service’s endpoints.
{% endstep %}
{% step %}
### Generate IDs
When you send API requests, the system will generate the required IDs automatically as part of its normal operation.
{% endstep %}
{% endstepper %}
## API Details
### API Reference
The complete API specifications for the Attendance Service are documented in the Swagger YAML file:
* **Swagger API YAML:** [Attendance-v1.0.0.yaml](https://github.com/egovernments/DIGIT-Specs/blob/master/Domain%20Services/Health/Attendance-v1.0.0.yaml)
This YAML file contains:
* API endpoints
* Request/response payloads
* Data models
* Error codes and descriptions
### Application Properties - Kafka Topic Configuration
Below are the Kafka topics configured in the `application.properties` file for the eGov persister:
| Functionality | Create Topic | Update Topic | Bulk Topic(s) |
| ------------------- | ------------------- | --------------------- | --------------------------------------------------------------------------------------------- |
| Attendance Register | save-attendance | update-attendance | |
| Attendance Staff | save-staff | update-staff | |
| Attendance Attendee | save-attendee | update-attendee | |
| Attendance Log | save-attendance-log | update-attendance-log | save-attendance-log-bulk-health (create)
|
**Properties format:**
```
attendance.register.kafka.create.topic=save-attendance
attendance.register.kafka.update.topic=update-attendance
attendance.staff.kafka.create.topic=save-staff
attendance.staff.kafka.update.topic=update-staff
attendance.attendee.kafka.create.topic=save-attendee
attendance.attendee.kafka.update.topic=update-attendee
attendance.log.kafka.create.topic=save-attendance-log
attendance.log.kafka.update.topic=update-attendance-log
attendance.log.kafka.consumer.bulk.create.topic=save-attendance-log-bulk-health
attendance.log.kafka.consumer.bulk.update.topic=update-attendance-log-bulk-health
```
### External Service URLs
Below are the URLs for external services that the Attendance Service interacts with:
| Service | Property Key | URL |
| -------------------- | ---------------------- | ------------------------------------------------------------- |
| eGov MDMS | egov.mdms.host |
```
The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
