> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/health/v2.1/deploy/configuration/hcm-ui-configuration/attendance-management/attendance-register-setup.md).

# Attendance Register Setup

### Overview

In HCM v2.1, attendance register setup has been integrated directly into the campaign workflow. Previously, registers had to be configured separately — now program managers can set up attendance registers without leaving the campaign creation process.

The setup flow runs **after** a campaign is created and consists of seven sequential steps. Each step reads and writes directly to the campaign API.

***

### What's New

#### Attendance Register Setup Flow

After creating a campaign, users can launch the attendance register setup from within the campaign workflow. The flow has seven steps:

| Step                      | What happens                                        |
| ------------------------- | --------------------------------------------------- |
| 1. Setup Attendance       | Entry screen — initiates the register setup process |
| 2. Create Registers       | Define the attendance registers for the campaign    |
| 3. Attendance Upload      | Upload attendance data via Excel                    |
| 4. Map Attendees          | Map attendees to the correct registers              |
| 5. Map Users to Registers | Assign users to specific registers                  |
| 6. Register Details       | Review and confirm register configuration           |
| 7. Reports Configuration  | Set up attendance reporting preferences             |

**How the flow works:**

```
Campaign created
  → Setup Attendance (entry)
  → Create Registers
  → Attendance Upload  (Excel-based)
  → Map Attendees
  → Map Users to Registers
  → Register Details
  → Reports Configuration
```

<figure><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FXfuQGC9POyey6gZDmmVR%2Fimage.png?alt=media&amp;token=ba9657dc-a1fd-4321-887b-93780145debd" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FweQHiLVXaYolDdsBwDIL%2Fimage.png?alt=media&amp;token=351724d7-e0a8-4064-960f-daa4261112a5" alt=""><figcaption></figcaption></figure>

<figure><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FBw8ajzVIV7d1KEYBE3C6%2Fimage.png?alt=media&amp;token=0bc985e9-6cb9-4664-809d-4e62b6a9f9be" alt=""><figcaption></figcaption></figure>

***

### Important Behaviours

* Each step is **independent** — steps do not share state with each other. Every step reads and writes directly to the campaign API.
* Navigation between steps is managed using the campaign name, campaign number, and tenant ID as URL query parameters.
* The flow is only accessible **after** the campaign has been created — it is not part of the initial creation wizard.

***

### New API Integrations

| Endpoint                                       | Method | Purpose                                                                |
| ---------------------------------------------- | ------ | ---------------------------------------------------------------------- |
| `/excel-ingestion/v1/data/process/_validation` | POST   | Validates the uploaded attendance register Excel file before ingestion |
| `/excel-ingestion/v1/data/process/_search`     | POST   | Polls the Excel ingestion status after upload                          |

***

### New Components

| Component                 | What it is                                          |
| ------------------------- | --------------------------------------------------- |
| `SetupAttendance.js`      | Entry screen for the attendance register setup flow |
| `CreateRegisters.js`      | Step to define registers for the campaign           |
| `AttendanceUpload.js`     | Excel-based attendance data upload step             |
| `MapAttendees.js`         | Step to map attendees to registers                  |
| `MapUsersToRegisters.js`  | Step to assign users to specific registers          |
| `RegisterDetails.js`      | Step to review register configuration               |
| `ReportsConfiguration.js` | Step to configure attendance reporting              |

All attendance register setup screens are in `src/pages/employee/NewCampaignCreate/`.

Config files driving each step:

* `createRegistersConfig.js`
* `attendanceUploadConfig.js`
* `mapAttendeesConfig.js`

***

### Localisation

New translation keys have been added for all Attendance Register Setup screens under `I18N_KEYS.CAMPAIGN_CREATE` in `src/utils/i18nKeyConstants.js`.

***

### Access and Permissions

| Role                  | What they can do                                                                                 |
| --------------------- | ------------------------------------------------------------------------------------------------ |
| Campaign-scoped users | Access and complete the attendance register setup flow for campaigns within their boundary scope |
| System administrator  | Full access to all campaign and register setup screens                                           |

***


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.digit.org/health/v2.1/deploy/configuration/hcm-ui-configuration/attendance-management/attendance-register-setup.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

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.
