Overview
Add a brief description of the topic and the page content (2-3 lines).MDMS stands for Master Data Management Service. MDMS is One of the applications in the eGov DIGIT core group of services. This 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.
Pre-requisites
Before you proceed with the configuration, make sure the following pre-requisites are met -
...
Add any system or skills requirements here (Use bullets to build the list)
Key Functionalities
Add 2-3 lines to highlight the use and applications in context.
Add functional aspects for the topic (Use bullets to build the list)
Tables can be inserted for certain topics.
...
Title
...
Description
Deployment Details
Deployment Steps (Use numbered bullet lists to define the sequence)
Configuration Details
Configuration steps (Use numbered bullet lists to define the sequence)
Integration
Integration Scope
Integration Benefits
Steps to Integration
Prior Knowledge of Java/J2EE.
Prior Knowledge of Spring Boot.
Prior Knowledge of REST APIs and related concepts like path parameters, headers, JSON, etc.
Prior knowledge of Git.
Advanced knowledge on how to operate JSON data would be an added advantage to understand the service.
Key Functionalities
The MDMS service reads the data from a set of JSON files from a pre-specified location.
It can either be an online location (readable JSON files from online) or offline (JSON files stored in local memory).
The JSON files will be in a prescribed format and store the data on a map. The tenantID of the file serves as a key and a map of master data details as values.
Once the data is stored in the map the same can be retrieved by making an API request to the MDMS service. Filters can be applied in the request to retrieve data based on the existing fields of JSON.
Deployment Details
For deploying the changes in MDMS data, the service needs to be restarted.
The changes in MDMS data could be adding new data, updating existing data, or deletion.
Configuration Details
The config JSON files to be written should follow the listed rules
The config files should have JSON extension
The file should mention the tenantId, module name, and the master name first before defining the data
Code Block |
---|
{
"tenantId": "uk",
"moduleName": "BillingService",
"{$MasterName}":[ ]
} |
Title | Description |
tenantId | Serves as a Key |
moduleName | Name of the module to which the master data belongs |
MasterName | The Master Name will be substituted by the actual name of the master data. The array succeeding it will contain the actual data. |
Example Config JSON for “Billing Service”
Code Block |
---|
{
"tenantId": "pb",
"moduleName": "BillingService",
"BusinessService":
[
{
"businessService": "PropertyTax",
"code": "PT",
"collectionModesNotAllowed": [ "DD" ],
"partPaymentAllowed": true,
"isAdvanceAllowed": true,
"isVoucherCreationEnabled": true
}
]
} |
Reference Docs
Doc Links
Title | Link |
Reference Doc Link 1 | |
Reference Doc Link 2 |
API List
Title | Link |
API Contract Reference | https://raw.githubusercontent.com/egovernments/egov-services/master/docs/mdms/contract/v1-0-0.yml |