iFIX Core Master Data Service
Overview
Master data service maintains information about Government and Chart of Accounts. 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:
Java 8
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 service provides the capabilities to maintain the Government details and allow users to Create and Search data. For 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 required Government.
API List
Title
Link
/government/v1/_create
/government/v1/_search
Chart Of Account
This service provides the capabilities to maintain the Chart of Account (COA) details and support 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 stored with the given request. Searching the details for COA is done based on the given search parameters like the Chart of Account IDs, COACodes, Government ID, majorHead, subMajorHead, minorHead, subHead, groupHead, objectHead.
API List
Title
Link
/chartOfAccount/v1/_create
/chartOfAccount/v1/_search
Interaction Diagram
Environment
No environment variables are required specific to the environment (migration).
Configurations and Setup
Update the DB and URI configurations in the dev.yaml, qa.yaml, prod.yaml file.
Make sure the keycloak server is up and running and has been configured with the required client ID.
References and Notes
Title
Link
Swagger Yaml
Postman collection
Last updated
Was this helpful?
