IFIX Core Master Data Service v2.0

Overview

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

Version

Current version : 2.0.0

Prerequisites

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

1. Java 8

2. MongoDB instance

Features

It creates secure endpoints for the master data service. The access token is required to create any master data.

The subsequent sections on this page discuss the service details maintained by the IFIX core 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 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. The following information is passed while creating the Chart of Accounts - 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, COACodes, Government ID, majorHead, subMajorHead, minorHead, subHead, groupHead, objectHead.

API List

Interaction Diagram

Open

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 the keycloak server is up and running and has been configured with the required client ID.

References and Notes