> 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/local-governance/v2.7/platform/configure-digit/configuring-digit-services/configuring-reports.md).

# Configuring New Reports

## Overview <a href="#overview" id="overview"></a>

Through report service, useful data get shown for a specific module based on some given criteria like date, locality, financial year, etc.

For example, PT dump report of property tax service you have to select from date to date, financial year etc and based on the criteria we can see all the data full filling the criteria. In the response we see all the details of a property which is paid between the given from date and to date, if we selected financial year then we can see the property which is paid for that specific financial year.

## Pre-requisites <a href="#pre-requisites" id="pre-requisites"></a>

Before you proceed with the configuration, make sure the following pre-requisites are met -

* User with permission to edit the git repository where reports are configured.
* Prior knowledge of YAML.
* Prior knowledge of SQL queries.
* Prior knowledge of the relation between the tables for which module you are going to write a report.

## Key Functionalities <a href="#key-functionalities" id="key-functionalities"></a>

* Users can write queries (like SQL queries) for fetching real-time data to display in a UI application.
* Users can apply filters like from date, to date, financial year, etc based on the report configuration.
* Users can download the result in PDF and XLS format.
* User can select or deselect the columns user wants to see.
* User can choose the number of records he/she wants to see on a page.

## Deployment Details <a href="#deployment-details" id="deployment-details"></a>

Once the changes have been done in the report configuration file we have to restart the report service so the report service will read the new configuration.

## Configuration Details <a href="#configuration-details" id="configuration-details"></a>

* To add a new report first add the file path in the reportFileLocationsv1\[[https://raw.githubusercontent.com/egovernments/configs/DEV/reports/reportFileLocationsv1.txt\]](https://raw.githubusercontent.com/egovernments/configs/DEV/reports/reportFileLocationsv1.txt%5D) (In this file, the path of the report configuration files get stored).
  * \<Module Name>=file:///work-dir/configs/reports/config/\<report file name>.yml
  * ex: pgr=file:///work-dir/configs/reports/config/pgr-reports.yml
* Once file path is added in the file reportFileLocationsv1, go to the folder /configs/reports/config \[[<img src="https://github.githubassets.com/favicon.ico" alt="" data-size="line">https://github.com/egovernments/configs/tree/DEV/reports/config%5D. - Connect to preview](https://github.com/egovernments/configs/tree/DEV/reports/config%5D.) Create a new file and name the file that you have given in file reportFileLocationsv1.
* Write the report configuration. Once it is done commit those changes.
* Add the role and actions for the new report.
* Restart the MDMS and report service.

## Reference Docs <a href="#reference-docs" id="reference-docs"></a>

#### Doc Links <a href="#doc-links" id="doc-links"></a>

| Description                                                                                                                | Link                                                                                                                                                                                                                                   |
| -------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [reportFileLocationsv1](https://raw.githubusercontent.com/egovernments/configs/DEV/reports/reportFileLocationsv1.txt) file | <https://raw.githubusercontent.com/egovernments/configs/DEV/reports/reportFileLocationsv1.txt>                                                                                                                                         |
| report config folder                                                                                                       | [<img src="https://github.githubassets.com/favicon.ico" alt="" data-size="line">https://github.com/egovernments/configs/tree/DEV/reports/config - Connect to preview](https://github.com/egovernments/configs/tree/DEV/reports/config) |

[![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)​](http://creativecommons.org/licenses/by/4.0/)All content on this page by [eGov Foundation](https://egov.org.in/) is licensed under a [Creative Commons Attribution 4.0 International License](http://creativecommons.org/licenses/by/4.0/).


---

# 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 dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digit.org/local-governance/v2.7/platform/configure-digit/configuring-digit-services/configuring-reports.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

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.