Overview
Ifix-Adapter is a system which 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 on how to setup set up the ifix-adapter service and describes the functionalities it provides supports.
Pre-requisites.
Before you proceed with the configuration, make sure the following pre-requisites are met -
...
IFIX client requests are pushed to IFIX
Authentication 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 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
...
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 hereMap clientcode, ifixcoacode, ifixid in ifix_adapter_coa_map table
“clientcode” is the taxhead 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
In other way you can Another way is to map the IFIX coa id COA ID itself. Since these are generated ids you cant port to other environments. You have to id mapping ID mapping has to be done for every environment.
Preference is given to COA Code, if it is null id ID will be used
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');
If client “project code” and IFIX project code are the same then no need of 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 in dash boardon the dashboard. This way you dont 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 nd and its client or has multiple projects having the same project code then only go for this mapping. Adapter 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 it will look into this table for mapping
example is INSERT INTO public.ifix_adapter_project_map(
id, clientprojectcode, ifixprojectid, tenantid)
VALUES (1, '7374', 'e42db9bb-8427-40a6-9939-4f2189d032bf','pb');
state.goverment.code
set this value to the clients top level tenantid
...