# Introduction

Aareon QL supports integration with Keyfax for our Repair Diagnostics and Enquiries modules. Below you can see Keyfax being launched from the Arreon QL housing management system. ### Launching Keyfax Within Aareon QL navigate to the property selection screen as shown below\...

The relevant property details are displayed. Note that there may be any number of pop-up windows and alerts before you can proceed. Simply click to **Continue** each of these.

### Repair Diagnostics #### **Aareon QL calling Keyfax** 1. Used to pick a SOR/Priority/Description amongst other details via scripting. 2. Passes in Keyfax company code, rent name & property address, tenancy sequence number, property code, tenancy type, order number. #### **Keyfax returning to Aareon QL** **Aareon** QL accepts back Priority, SoR item (also checks for item INSP if so, mark as requiring a pre-inspection), quantity, fault description (which goes into message 1), additional info (which goes into message 2) At launch QL passes Keyfax the company code, name and property address, tenancy sequence number, property code, tenancy type and order number. The integration gives Keyfax the ability to populate the following fields in QL Single Order Entry screen on submission of a diagnosed repair in Keyfax. | Field | Description | | ------------------------ | ---------------------------------------------------------------- | | **Repair Code** | Populated with the chosen Keyfax Service | | **Priority** | Populated with the chosen Keyfax Priority | | **Message Line 1** | Populated with the Keyfax Recorded Text | | **Message Line 2** | Populated with the Keyfax Additional Info text | | | | | **Zero Value** | Populates the tick box field zeroing the order value | | **Recharge** | Populates the tick box field \*Requires QL version 4.2 or higher | | | | | **The following added:** | QL v3.2 / InterView v4.1.5.x | | **Contractor Ref** | Populated using fixed text by the Keyfax Administrator | | **Work Type** | Populated using fixed text by the Keyfax Administrator | | **Classification** | Populated using fixed text by the Keyfax Administrator | | **SOR volume** | Populated using fixed text by the Keyfax Administrator | QL also checks for item INSP (Service) to mark as requiring a pre-inspection.

### General Enquiries #### **Aareon QL calling Keyfax** 1. Used to pick a desired action to process 2. Passes in Keyfax company code, rent name & property address, tenancy sequence number, property code, tenancy type. #### **Keyfax returning to Aareon QL** **Aareon** QL accepts back Enquiry Text (goes into Brief Description), Note which contains 3 classes (CLASS1=\

, CLASS2=\ etc) and the rest of the note goes into full description.

At launch QL passes Keyfax the company code, name and property address, tenancy sequence number, property code, tenancy type and client ID *(client ID optional).*

The integration gives Keyfax the ability to populate the following fields in the QL Contact Creation screen on submission of a diagnosed enquiry in Keyfax. Populating the Additional Classes allows Keyfax to 'trigger' a predefined workflow in QL.

| Field                  | Description                       |
| ---------------------- | --------------------------------- |
| **Additional Classes** | Populated using a Keyfax Note     |
| **Brief Description**  | Populated using the Recorded Text |
| **Full Desc**          | Populated using a Keyfax Note     |



**Additional Classes**: A class is a means of conveying data from Keyfax InterView to QL. 5 Classes are supported and the population of these Classes are defined using a Keyfax Note, shown below.



**Brief Description -** The Recorded Text is picked up from the export XML and placed in the ‘Brief Description’ field in the QL Contact Creation screen. By manipulating the recorded text in the Keyfax Administration tools this allows for a quick reference summary of the contact with the tenant, detailing Category and Topic chosen followed by any Script data considered relevant to the Keyfax administrator / organisation.

**Full Desc -** The full description may contain any text required, including Databox bookmarks. The full description is also taken from a Keyfax Note, using the same Note created to pass the Additional Classes.

To allow QL to differentiate between Note text for the Additional Classes and Note text for the full description, a paragraph close mark-up (``) is required after the Additional Classes.



Do not use a line break (`
`) as QL cannot then differentiate and the full description will receive the Additional Class values and mark-up, shown below.



You can confirm that the HTML Markup is correct by clicking the **Source** button:



{% hint style="info" %}
`*`Originally, QLx handled **THREE** classes. It is possible that older versions of QLx will not support more than 3 (possibly 5) - please check with Aareon.
{% endhint %}

### How it works

The integration between Aareon QL and Keyfax is provided by two technologies:

* [SOAP API](/integrations/apis/soap.md)- no need for any Client installation
* [Keyfax Client](/product-suite/client.md) - this needs to be installed on every machine running QL that wishes to launch Keyfax scripts

{% hint style="info" %}
**NOTE** It is our understanding that both the above integrations support the same startup/export processing and fields. Going forward, this may not always be the case so we recommend confirming this with Aareon. 
{% endhint %}


---

# Agent Instructions: 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:

```
GET https://docs.keyfax.biz/integrations/host-systems/aareon/introduction.md?ask=
```

The question should be specific, self-contained, and written in natural language.
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.