> 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/platform/build/core-services/mdms-v2-master-data-management-service/mdms-master-data-management-service.md).

# MDMS (Master Data Management Service)

Configure master data management service

## Overview

The MDMS service 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 different services to store and retrieve data that is seldom changed, the MDMS service keeps them in a single location for all modules and provides data on demand 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.

<table><thead><tr><th width="266">Environment Variables</th><th>Description</th></tr></thead><tbody><tr><td>egov.mdms.conf.path</td><td>The default value of folder where master data files are stored</td></tr><tr><td>masters.config.url</td><td>The default value of the file URL which contains master-config values</td></tr></tbody></table>

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

1. [Deploy](https://docs.digit.org/platform/deep-dive/deployment-key-concepts/deploying-digit-services.md) the latest version of the MDMS-service
   1. **Note**: This video will give you an idea of how to deploy any Digit-service. Further you can find the latest builds for each service in out latest [release document](https://docs.digit.org/platform/introducing-digit/releases/digit-2.9-lts/service-build-updates.md) here.
2. Add [conf path](https://github.com/egovernments/Digit-Core/blob/f7b71c2e2b5c312b94b4738749a781d0ef874eab/core-services/egov-mdms-service/src/main/resources/application.properties#L7) for the file location
3. Add [master config](https://github.com/egovernments/Digit-Core/blob/f7b71c2e2b5c312b94b4738749a781d0ef874eab/core-services/egov-mdms-service/src/main/resources/application.properties#L8) JSON path

Note : See the [Reference Docs](#reference-docs) for the values of conf path and master config.

## **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.

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

1. To integrate, the 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

### Doc Links

| Title                                                                                                                                                                                                                                           |
| ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| egov-mdms sample data - [https://github.com/egovernments/egov-mdms-data/tree/DEV/data - Connect to preview](https://github.com/egovernments/egov-mdms-data/tree/DEV/data) \[Download this and refer it's path as conf path value]               |
| master-config.json - [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) \[Refer to this path as master config value] |

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

| Title                                                                                        |
| -------------------------------------------------------------------------------------------- |
| [egov-mdms-service/v1/\_search](https://www.getpostman.com/collections/fcc9a71375b674de1308) |

## Access to all the API's at : [DIGIT-Playground](https://digit-api.apidog.io/doc-507201)


---

# 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/platform/build/core-services/mdms-v2-master-data-management-service/mdms-master-data-management-service.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.
