Ifix Adatpter Services v1.0

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

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 and database is created to store failure and success

• Following services should be up and running:

  • Client Service Like mgramseva-ifix-adapter

  • fiscal-event-service

  • keycloak

Key Functionalities

• Ifix client requests pushed to IFIX

• Auth token is fetched from keycloak and cached. Token will be refetched 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 by scheduller

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

Integration

Integration Scope

PGR service can be integrated with any organisation or system which wants to track customer queries or complaint. The organisations can customise the workflow depending on there product requirements 

Integration Benefits

• Easy tracking and resolution of complaints

• Configurable workflow according to client requirement

Steps to Integration

1. Customer can raise a complaint using the /requests/_create

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

3. Once the complaint is raised the organisation or system can call /requests/_update endpoint to move the application further in workflow until it get resolved

Interaction Diagram

Reference Docs

Doc Links

API List