> For the complete documentation index, see [llms.txt](https://docs.digit.org/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.digit.org/public-finance/v2.3/exemplar/ifix-adapter.md).

# iFIX Adapter

## Overview

iFIX Adapter enables existing or new source systems to integrate seamlessly with iFIX. iFIX Adapter has been developed as a reference implementation for developers of source systems who want to integrate their departmental system with iFIX. 

iFix Adapter works as a mediator between iFIX and its clients. This system will receive requests from the client system and converts the data into the iFIX fiscal event or associated formats. 

## Pre-requisites <a href="#pre-requisites." id="pre-requisites."></a>

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

## Key Functionalities <a href="#key-functionalities" id="key-functionalities"></a>

* iFIX client requests pushed to IFIX
* Auth token is fetched from keycloak and cached. Token will be 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 resubmitted by scheduler

## Deployment Details <a href="#deployment-details" id="deployment-details"></a>

1. Update the keycloak credentials client-id and secrets in the 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 <a href="#configuration-details" id="configuration-details"></a>

1. Update Key cloak credentials in dev.yaml, qa.yaml, prod.yaml according to environment

## Interaction Diagram <a href="#interaction-diagram" id="interaction-diagram"></a>

![](/files/-MjIHADp2mb0ubhWNTdq)

> [![Creative Commons License](https://i.creativecommons.org/l/by/4.0/80x15.png)*​*](http://creativecommons.org/licenses/by/4.0/)*All content on this page by* [*eGov Foundation*](https://egov.org.in/) *is licensed under a* [*Creative Commons Attribution 4.0 International License*](http://creativecommons.org/licenses/by/4.0/)*.*


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:

```
GET https://docs.digit.org/public-finance/v2.3/exemplar/ifix-adapter.md?ask=<question>&goal=<endgoal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.