Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Overview

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

...

  • Java 8

  • Kafka server is up and running

  • PSQL server is running and database is created to store failure and success

  • Redis

  • Following services should be up and running:

    • Client Service Like mgramseva-ifix-adapter

    • Target service IFIX- fiscal-event-service

    • Target Service IFIX-keycloak

Key Functionalities

  • Ifix client requests pushed to IFIX

  • Auth token is fetched from keycloak and cached. Token will be refetched re fetched 5 minutes before expiry

  • Every push to Ifix is recoded with http status

    • status series 200 series considered success

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

    • status 500 resubmited resubmitted by schedullerscheduler

Deployment Details

  1. update the keycloak credentials client-id and secrets in environment file

  2. Map the coa in HeadCodeToCoaMapping.yml

  3. Map project in ProjectMapping.yml

  4. 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

Integration

Integration Scope

...

Integration Benefits

...

  • Easy tracking and resolution of complaints

  • Configurable workflow according to client requirement

Steps to Integration

...

Customer can raise a complaint using the /requests/_create

...

Organisation or System can search the complaint using /requests/_searchendpoint

...

Interaction Diagram

...

Reference Docs

...

Title 

...

Link

...

 Workflow Technical Document

...

 Workflow Service

...

 User Technical Document

...

User Service  

...

MDMS Technical Document

...

NEEDS TO BE UPDATED

...

IDGen Technical Document

...

NEEDS TO BE UPDATED

...

Localization Technical Document

...

NEEDS TO BE UPDATED

...

Persister Technical Document

...

API List

Title 

Link

  Yaml Link

https://www.getpostmangithub.com/collections/09154f94d2c291a96777/egovernments/iFix-Dev/blob/adaptor-dev/reference-adapter/iFix-adapter-v1.0.yaml