> For the complete documentation index, see [llms.txt](https://docs.keyfax.biz/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.keyfax.biz/technical/general/architecture.md).

# Keyfax Architecture

## Keyfax Staff

Keyfax is designed as a three-tier application which is controlled (typically but not exclusively) by a Housing management System (HMS) host application that requires the ability to diagnose Repair or Enquiry data.

The following schematic describes the Keyfax V4.x architecture in a typical Call Centre environment:

<div align="left"><figure><img src="/files/72BFILFnWO8eRvV2nIbV" alt=""><figcaption></figcaption></figure></div>

Note that a single Keyfax installation can support an infinite number of instances. In the above diagram, this is depicted by the two databases, two sets of scripts etc. Access to a particular instance is controlled by the passing of configuration data to Keyfax upon launch(i.e. Company Code).

Instances can also share the same database.

### Keyfax Self-Service

For self-service environments, Keyfax is usually launched via a client website or public facing portal:

<div align="left"><figure><img src="/files/bWSSesPVfL9t6aM9saJn" alt=""><figcaption></figcaption></figure></div>


---

# 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.keyfax.biz/technical/general/architecture.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.