Mgramseva iFix Adapter Services v2.0

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 will be 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 collect projectId form request data and treat it as department_entity_code and call search API to Department Entity Service. It always expect it will receive only one Department Entity against single department_entity_code, if it finds multiple raise an error message.

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

Deployment Details

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

Configuration Details

1. Update Key cloak credentials in dev.yaml,qa.yaml,prod.yaml according to 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. 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