Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Current version : 0.1.0

Prerequisites

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

  1. Java 8

  2. MongoDB instance

  3. Required service dependency - Department entity service

Features

Create endpoint of It creates secure endpoints for the master data service is secure and we need the . The access token for creating is required to create any master data.

Master data service maintains the details of the below services:The subsequent sections on this page discuss the service details maintained by the master data service.

Government

This maintains the Government details and supports create and search Government details. While creating the Government, we need a unique Id for the Government and a name for the same. Optionally, we can pass some additional details as part of the attribute. In the case of search, passing the unique idID(s) as search parameters can give you all the details of the Government.

...

This maintains the Chart of Account(COA) details and supports create and search of COA. While The following information is passed while creating the Chart of Accounts , we need to pass the - Government Id, majorHead, subMajorHead, minorHead, subHead, groupHead, objectHead and corresponding head names & types. A unique code named COACode is generated by combining (concatenating) majorHead, subMajorHead, minorHead, subHead, groupHead, objectHead with a hyphen ("-") and store with the given request.
Searching the details for COA is done based on the provided search parameters like the Chart of Account IDs, COACode, Government ID, majorHead, subMajorHead, minorHead, subHead, groupHead, objectHead.

...

Maintains the create and search department details. While The following information is passed while creating the department , pass - the Government IdID, department code, department name, parent department if any. Searching the department details will be is on given parameters like IDs, Government ID, department code, department name.

...

Maintains the expenditure details And provide create and search functionality. In case of For creating the expenditure, need to pass the following details are required - the Government idID, the department idID, code, name, type (can be "SCHEME", "NON_SCHEME") details. While searching the expenditure details, pass the given parameters like idsIDs, Government idIDs, name, code.

API List

...

Maintains the project details and provide create and search functionality. In case of creating the project, need to pass The following details are required to create the project - Government, name, code, expenditure ID, the department entity ID, location IDs. While searching, pass the IDs, Government ID, name, code, expenditure ID, location ID.

It The Project contains department entity information along with its hierarchy level detail and also attaches master department information (department id - UUID). Here we keep all All child information list at lists for every department node (department record) is maintained here. Leaf level department will not have any child info.

Child list contains department entity ID list, which makes current department entity parent of all children child list (department id list), that's how it maintains . This is how the department entity level details and information is maintained.

API List

Interaction Diagram

...

...

Environment

There will not be any environment variables required specific to the environment (migration).

...

  1. Update all the DB and URI configuration in the dev.yaml, qa.yaml, prod.yaml file.

  2. Make sure the keycloak server is up and running And have and has been configured with the required client ID.

References and Notes

...