> 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/services-overview/core-services/mdms-services.md).

# MDMS (Master Data Management Service)

## Overview

One of the applications in the DIGIT core group of services aims to reduce the time spent by developers on writing codes to store and fetch master data ( primary data needed for module functionality ) which doesn’t have any business logic associated with them. Instead of writing APIs, and creating tables in every different service to store and retrieve data that is seldom changed MDMS service keeps them at a single location for all modules and provides data on will with the help of no more than three lines of configuration.

## **Pre-requisites**

1. Prior Knowledge of Java/J2EE.
2. Prior Knowledge of Spring Boot.
3. Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON etc.
4. Prior knowledge of Git.
5. Advanced knowledge of how to operate JSON data would be an added advantage to understanding the service.

## **Key Functionalities**

* Adds master data for usage without the need to create master data APIs in every module.
* Reads data from GIT directly with no dependency on any database services.

| Environment Variables | Description                                                           |
| --------------------- | --------------------------------------------------------------------- |
| egov.mdms.conf.path   | The default value of folder where master data files are stored        |
| masters.config.url    | The default value of the file URL which contains master-config values |

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

1. Deploy the latest version of Mdms-service
2. Add conf path for the file location
3. Add master config JSON path

## **Integration Details**

### Integration Scope <a href="#integration-scope" id="integration-scope"></a>

The MDMS service provides ease of access to master data for any service.

### Integration Benefits <a href="#integration-benefits" id="integration-benefits"></a>

* No time spent writing repetitive codes with no business logic.

### Steps to Integration <a href="#steps-to-integration" id="steps-to-integration"></a>

1. To integrate, host of egov-mdms-service should be overwritten in the helm chart
2. *egov-mdms-service/v1/\_search* should be added as the search endpoint for searching master data.
3. Mdms client from eGov snapshots should be added as mvn entity in pom.xml for ease of access since it provides mdms request pojos.

## Reference Docs

### Docs

| Title                 | Link                                                                                                                                                                                                                                                         |
| --------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| egov-mdms sample data | [<img src="https://github.githubassets.com/favicon.ico" alt="" data-size="line">https://github.com/egovernments/egov-mdms-data/tree/DEV/data - Connect to preview](https://github.com/egovernments/egov-mdms-data/tree/DEV/data)                             |
| master-config.json    | [<img src="https://github.githubassets.com/favicon.ico" alt="" data-size="line">https://github.com/egovernments/egov-mdms-data/blob/DEV/master-config.json - Connect to preview](https://github.com/egovernments/egov-mdms-data/blob/DEV/master-config.json) |

### API List <a href="#api-list" id="api-list"></a>

| Title                         | Link                                                          |
| ----------------------------- | ------------------------------------------------------------- |
| egov-mdms-service/v1/\_search | <https://www.getpostman.com/collections/fcc9a71375b674de1308> |

[![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/services-overview/core-services/mdms-services.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.