IFIX Master Data Service

Overview

Master data service maintains information of Government, Chart of Account, Department, Expenditure and Project. We can create these details and search the same details based on the given parameters/request data.

Version History

Current version : 0.1.0

Prerequisites

Before you 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 the master data service is secure and we need the access token for creating any master data.

Master data service maintains the details of the below services:

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 id(s) as search parameters can give you all the details of the Government.

API List

Chart Of Account

This maintains the Chart of Account(COA) details and supports create and search of COA. 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 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.

API List

Department

Maintains the create and search department details. While creating the department, pass the Government Id, department code, department name, parent department if any. Searching the department details will be on given parameters like IDs, Government ID, department code, department name.

API List

Expenditure

Maintains the expenditure details And provide create and search functionality. In case of creating the expenditure, need to pass the Government id, department id, code, name, type (can be "SCHEME", "NON_SCHEME") details. While searching the expenditure details, pass the given parameters like ids, Government id, name, code.

API List

Project

Maintains the project details and provide create and search functionality. In case of creating the project, need to pass 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 contains department entity information along with its hierarchy level and also attaches master department information (department id - UUID). Here we keep all child information list at every department node (department record). 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 list (department id list), that's how it maintains department entity level.

API List

Interaction Diagram:

Environment

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

Configurations and Setup

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

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

References and Notes