> 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/access/public-health-product-suite/health-campaign-management-hcm/custom-reports/custom-reports-user-manual.md).

# Custom Reports User Manual

## Overview

This manual explains how campaign reports are configured and consumed within the HCM platform. It covers two roles:

* Campaign Manager — configures which reports are generated for a campaign and how often they run.
* Program Manager / National Supervisor — accesses campaign-scoped reports directly from their dashboard and downloads them.

Once a Campaign Manager selects and configures reports during campaign setup, those reports automatically become available to Program Managers and National Supervisors for every campaign assigned to them, without any additional setup.

Report configuration is one of the final steps of campaign setup, alongside delivery strategy, mobile app setup, and supervisor checklists.

## Steps

{% stepper %}
{% step %}

### Open Configure Reports

From the campaign home page, locate the **Configure Reports** card.

Click **Configure Reports**.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FDcvGSRywNDbgCFa3KjZz%2Funknown.png?alt=media&amp;token=4474fa1d-42d1-4dc1-843e-d7096825fdfd" alt="Figure 1: Campaign setup checklist with the “Configure reports” step highlighted." height="276" width="600"></div>
{% endstep %}

{% step %}

### Select the reports to include

On the **Select the reports for the campaign** screen, review the list of available reports.

Check the box next to each report to include it. All reports are selected by default.

The heading above the list (example: *Available Reports (6 selected)*) updates to reflect your current selection.

Click **Next** to continue.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FJ0QZXSaiMYvzpxzOJPBj%2Funknown.png?alt=media&amp;token=2a4f3b3b-f243-4dd1-a158-4197c424d194" alt="Figure 2: Report selection screen" height="274" width="600"></div>

Six report types are available. The available report types are:

<table><thead><tr><th width="179.9375">Report</th><th>Purpose</th></tr></thead><tbody><tr><td>Stock Report</td><td>Tracks stock transactions, movement, quantities, facilities, users, and transaction details.</td></tr><tr><td>Attendance Report</td><td>Tracks attendance records and field worker participation.</td></tr><tr><td>Beneficiary Visit List Report</td><td>Lists beneficiary visits recorded during the campaign.</td></tr><tr><td>Anomaly Report</td><td>Tracks anomalies generated across provinces and districts, along with associated users.</td></tr><tr><td>Registered Report</td><td>Tracks beneficiaries and households registered through the campaign, with registration details.</td></tr><tr><td>Adverse Reaction Report</td><td>Tracks reported adverse reactions during the campaign.</td></tr></tbody></table>
{% endstep %}

{% step %}

### Set the frequency for each report

On the **Configure Report Frequency** screen, open the **Select Frequencies** dropdown for each report.

Choose one or more frequencies — Daily and/or End of Campaign. Multiple frequencies can be selected per report.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FqFyTImIRzHApr4nRjdgw%2Funknown.png?alt=media&amp;token=34ba06c1-43ae-4fc0-b0b3-9c807c250657" alt="Figure 3: Frequency dropdown open for the Registered Report, showing Daily and End of Campaign options." height="274" width="600"></div>

Selected frequencies appear as removable tags (e.g. “Daily ✕”) below the dropdown. Use **Clear All** to remove all frequencies for a report.

Click **Save Configuration** once all required reports have a frequency set.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2F7KhCOZicUVP0QATahmJd%2Funknown.png?alt=media&amp;token=086af6bd-2532-4c1a-80c8-1e5c6c41dd00" alt="Figure 4: Confirmation banner after saving — “Reports configuration saved successfully.”" height="274" width="600"></div>

{% hint style="info" %}
Note: Reports marked with a red asterisk (\*) require at least one frequency before the configuration can be saved.
{% endhint %}

After saving, the reports and their configured frequencies are attached to the campaign and become visible to Program Managers and National Supervisors automatically.
{% endstep %}

{% step %}

### Access Campaign Reports

Program Managers / National Supervisors do not need to configure anything themselves. Once they log in, campaign-scoped reports configured by the Campaign Manager are available directly from their dashboard.
{% endstep %}

{% step %}

### Log in and open the Dashboard

Log in to the HCM platform.

Select **Dashboard** from the home screen.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FXy1YTwSR08UPGFglb3bt%2Funknown.png?alt=media&amp;token=5ca8fa21-f2b5-4fd5-a242-8f87bfff0f80" alt="Figure 5: Home screen showing the Dashboard tile." height="181" width="400"></div>
{% endstep %}

{% step %}

### View assigned campaigns

The Dashboard opens to **My campaigns,** listing every campaign assigned to the logged-in user.

Each campaign card shows its name, type, boundary, project type, start/end dates, and campaign number.

Use the **Campaign name** and **Campaign type** filters to search for a specific campaign.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2Fn1AR2qOu7N2abr0WI3br%2Funknown.png?alt=media&amp;token=3be5bf47-d96a-4d94-a943-378c31a5ac8b" alt="Figure 6: “My campaigns” list, showing assigned campaigns with View Reports and View Dashboard actions." height="274" width="600"></div>
{% endstep %}

{% step %}

### Open reports for a campaign

On the campaign card, click **View Reports**.

The **Reports** screen lists the report types configured for that campaign — matching the selections the Campaign Manager made in Section 2.

Click **View Reports** next to any report type to open it.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2FRZIwiCFnCFvzQzJmtzuU%2Funknown.png?alt=media&amp;token=c3135392-c363-4505-a68b-081007bc13d8" alt="Figure 7: Campaign-scoped Reports list (Stock, Anomaly, Attendance, Registered, etc.)." height="271" width="600"></div>

{% hint style="info" %}
**Note:** Only the report types selected by the Campaign Manager during setup appear here. If a report is missing, ask the Campaign Manager to add it under “Configure Reports.”
{% endhint %}
{% endstep %}

{% step %}

### View and Download a Report

On the **Report Detail** screen, reports are grouped by frequency (example: **Daily Reports**) and listed by date, most recent first.

Use **Filter by Trigger Date** and **Search** to find a report for a specific date.

Each dated entry shows a status:

* **In Progress** — the report is still being generated; a progress bar shows completion percentage.
* **Completed** — the report is ready, showing its triggered time and file size, with a **Download Report** button.

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2F7g6Ub4ET271L83mQqLBE%2Funknown.png?alt=media&amp;token=5680626e-6cd2-4525-8316-b1387e564746" alt="Figure 8: Stock Report detail screen — reports for 14–17 September are still in progress" height="274" width="600"></div>

<div align="left"><img src="https://2077406040-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2FI0KFbSBTySIQ7TCOKnJF%2Fuploads%2F6ek26fc1QXPskiCbLxtb%2Funknown.png?alt=media&amp;token=d6057324-e299-454a-a1b4-a40337b92bf6" alt="Figure 9: Scrolling down shows the 17th September report completed, with file size and a Download Report button" height="273" width="600"></div>

Click **Download Report** to save the completed report file.

To generate a report for a custom date range instead of a fixed frequency, click **Generate Custom Range Reports** at the top of the screen.

{% hint style="info" %}
**Note:** Reports labelled **Contains PII** include personally identifiable information. Handle downloaded files according to your organization's data protection policy.
{% endhint %}
{% endstep %}
{% endstepper %}


---

# 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/access/public-health-product-suite/health-campaign-management-hcm/custom-reports/custom-reports-user-manual.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.
