Overview

Ifix-Adapter is a system that works as a mediator between iFix and its clients. This system will receive requests from the client system and convert the data in the Ifix required format. This document contains the details about how to set up ifix-adapter service and describes the functionalities it provides.

Pre-requisites

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

• Java 8

• Kafka server is up and running

• PSQL server is running

• Redis

• Following services should be up and running:

  • Client Service Like mgramseva-ifix-adapter

  • Target service IFIX- fiscal-event-service

  • Target Service IFIX-keycloak

  • IFIX master-data-service

Key Functionalities

• IFIX client requests are pushed to IFIX

• The authentication token is fetched from keycloak and cached. Token will be re-fetched 5 minutes before expiry

• project id is fetched from IFIX and cached

• COA id fetched from IFIX and cached

• Every push to IFIX is recorded in the table with HTTP status

  • status series 200 considered success

  • status 400 are marked client error and reported back to the client

  • status 500 resubmitted by the scheduler

Deployment Details

Deploy the latest version of ifix-reference-adapter

Configuration Details

1. Update Key cloak credentials in dev.yaml,qa.yaml,prod.yaml according to the environment The credentials are “keycloak.credentials.clientid and “keycloak.credentials.clientsecret” Example is given in here and here

2. Map clientcode, ifixcoacode, ifixid in ifix_adapter_coa_map table

   1. “clientcode” is the tax head like “WATER_CHARGES” or ‘10011’ used in IFIX client like mgramseva

   2. “ifixcoacode” is the 16 digit glcode in IFIX. 16 digit code is mapped then this can be ported to any environment like dev to qa ,or qa to uat or from uat to prod. Prefer mapping ifixcoacode

   3. Another way is to map the IFIX COA ID itself. Since these are generated ids you cant port to other environments. ID mapping has to be done for every environment.

   4. Preference is given to COA Code, if it is null ID will be used

   5. example is INSERT INTO public.ifix_adapter_coa_map( id, clientcode, ifixcoacode, ifixid, tenantid) VALUES (1,'10101', '0215-01-102-00-00-01', '6cbcb4a1-2431-4f78-89d7-b4f0565aba37', 'pb');

3. If client “project code” and IFIX project code are the same then no need for mapping. If it is different then map clientprojectcode, ifixprojectid in ifix_adapter_project_map table. Ideally, you should keep both codes the same for getting meaningful data on the dashboard. This way you don't have to do any mapping for project code for any environment. But if for any reason you have different project codes in IFIX and its client or has multiple projects having the same project code then only go for this mapping. The adapter will first check in the IFIX for the supplied “projectCode”, If found it will use it and caches it. If multiple projects or not found it will look into this table for mapping

   1. example is INSERT INTO public.ifix_adapter_project_map( id, clientprojectcode, ifixprojectid, tenantid) VALUES (1, '7374', 'e42db9bb-8427-40a6-9939-4f2189d032bf','pb');

4. state.goverment.code set this value to the clients top level tenantid

Interaction Diagram

Reference Docs

Doc Links

API List

Overview

Ifix-Adapter is a system that works as a mediator between iFIX and its clients. This system will receive requests from the client system and convert the data in the iFIX required format This document contains the details on how to set up the iFIX-adapter service and describes the functionalities it supports. It supports multiple events (Event Array) in a single request.

Pre-requisites

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

• Java 8

• Kafka server is up and running

• PSQL server is running

• Redis

• Following services should be up and running:

  • Client Service Like mgramseva-ifix-adapter

  • Target service IFIX- fiscal-event-service

  • Target Service IFIX-keycloak

  • Adapter master data service

Key Functionalities

• IFIX client requests are pushed to IFIX.

• The authentication token is fetched from keycloak and cached. Token is re-fetched 5 minutes before expiry.

• project_id from request data is getting treated as Department Entity Code to fetch Department Entity.

• COA Code fetched from COA Mapping table by client code and cached it in Redis Server.

• Every push to IFIX is recorded in the table with HTTP status

  • status series 200 considered success

  • status 400 are marked client error

• It collects projectId form request data and treats it as department_entity_code and calls search API to Department Entity Service. It always expects it will receive only one Department Entity against a single department_entity_code, if it finds multiple raise an error message.

• One project can have multiple department entities but vice-versa cannot be true. In case of multiple projects for one department entity - the system will raise an error message.

Deployment Details

Deploy the latest version of the ifix-reference-adapter.

Configuration Details

2. Map clientcode, ifixcoacode, ifixid in ifix_adapter_coa_map table

   • “clientcode” is the tax head like “WATER_CHARGES” or ‘10011’ used in IFIX client like mgramseva

   • “ifixcoacode” is the 16 digit glcode in IFIX. 16 digit code is mapped then this can be ported to any environment like dev to qa ,or qa to uat or from uat to prod. Prefer mapping ifixcoacode

   • example is INSERT INTO public.ifix_adapter_coa_map(id, clientcode, ifixcoacode, ifixid, tenantid) VALUES (1,'10101', '0215-01-102-00-00-01', '6cbcb4a1-2431-4f78-89d7-b4f0565aba37', 'pb');

3. state.goverment.code set this value to the clients top level tenant_id

Interaction Diagram

Reference Docs

Doc Links

API List

Follow the steps below to create the Adapter Master Data. Individual Adapter Service documents can be .

1. Enter valid details along with Tenant ID to create the Department. Once the tenant ID is created, the user receives a response with an ID and related details. This ID is the Department ID.

2. Enter valid details along with Tenant ID to create the Expenditure. Once the tenant ID is created, the user receives a response with an ID and related details. This ID is the Expenditure ID.

3. Enter valid hierarchy details of the Master Department to create Department Hierarchy. Check for more information.

4. Provide valid details to create Department Entity. Check for more information.

5. On successful completion of steps 1 to 4, enter valid details to create a project. Check for more information.

All content on this page by is licensed under a .

Overview

Adapter master data service maintains information on Department, Expenditure and Projects. We can create these details and search for the same details based on the given parameters/request data.

Version

Current version : 1.0.0

Pre-requisites

Before 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

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 master data service.

Department

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

API List

Expenditure

Maintains the expenditure details And provide create and search functionality. For creating the expenditure, the following details are required - the Government ID, the department ID, code, name, type (can be "SCHEME", "NON_SCHEME") details. While searching the expenditure details, pass the given parameters like IDs, Government IDs, names, code.

API List

Project

Maintains the project details and provide create and search functionality. The following details are required to create the project - Government, name, code, expenditure ID, the department entity ID(s), location IDs. While searching, pass the IDs, Government ID, name, code, expenditure ID, location ID.

API List

Interaction Diagram

Environment

No environment-specific variables are required for the environment (migration).

Configurations and Setup

Update the DB and URI configurations in the dev.yaml, qa.yaml, prod.yaml file.

References and Notes

Master Project API With Example

Project Create API creates the project when the Master data details (COA, Government, Expenditure, Department) and Department Entity have been created. COA And Government have to be created in iFIX core Master data service.

Project Create API takes the below attributes in request :

1. tenantId: This is the Id that will be defined while creating the Ifix core Master Government Service.

2. expenditureId: This is the Id that will be generated while creating the Adapter Master Expenditure Service.

3. code: This is the project code that needs to be created.

4. name: This is the project name that needs to be created.

For reference, Below is a Dummy project create example:

Request :

Response: