# Capita Housing / Academy

{% hint style="info" %}
**NOTE** This document was created with screen shots and certain information supplied by Capita Software Services (CSS), not only are the contents subject to change without notification but some of the processes or steps explained in the testing of the integration may require additional support from CSS. Also note that references to **JOBFAX** have been superceded by **Keyfax** although where configuration parameters are involved, these settings continue to use the JOBFAX nomenclature.
{% endhint %}

Once the Keyfax Client has been installed on the PC or Terminal Services server the Academy system needs to be configured to allow the exchange of data with Keyfax. 

### Academy Environment Variables

The following environment variables need to be set in the Academy Launcher:

| Name                 | Description                                                                                                                                                                                                                                                                                                       |
| -------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `ACADEMY_EXTREPAPP`  | <p>Versions 3 – 6: Set to JOBFAX  </p><p>Version 7: Set to JOBFAXXML</p><p>This MUST be in capital letters.</p>                                                                                                                                                                                                   |
| `ACADEMY_EXTREPPATH` | <p>A complete path to a Keyfax component which Academy uses to determine if the Keyfax Client is present. E.g. ‘<strong>C:\Program Files\Keyfax\testocx.exe</strong>'.<br><em>Note: early Keyfax integrations installed a program named <strong>keyfax.exe</strong>; this is no longer supplied.</em></p><p> </p> |
| `ACADEMY_EXTREPOUT`  | <p>The complete absolute path of the output file produced by Keyfax.</p><p>Version 3 – 6: ‘C:\Program Files\Keyfax\export.ini'</p><p>Version 7: ‘C:\Program Files\Keyfax\export.xml'</p>                                                                                                                          |
| `II_LIBU3GL`         | <p>This Ingres variable has to be modified to include a new Dynamic Link Library called KEYFAX DLL, which is supplied by CSS and should be included in the PCIMAGES area. (Note that this DLL may be corrupted and if problems are encountered, should be replaced - see <em>Keyfax DLL</em> below).</p><p> </p>  |
| `ACADEMY_JOBPASS`    | <p>Set to the global password defined on Keyfax Repair Diagnostics i.e. ‘<strong>Global</strong>'</p><p> </p>                                                                                                                                                                                                     |

These are set in the Properties screen under the Environment tab. This dialog is displayed when right-clicking the connection icon required in he Academy Launcher and selecting the ‘Properties' menu item from the context sensitive menu; see the screen capture below:

<figure><img src="/files/mJvJp4DOkR1XmaJIWkO9" alt=""><figcaption></figcaption></figure>

### Executable

The Academy **PC Images** folder should contain an executable file supplied by CSS (`EXTEVENT.EXE`), which Keyfax will call once a repair script is completed. The location of this program must be known before any Keyfax Client installations are run. The path must be specified in the installation configuration file `KF`**`nn`**`INSTALL.INI` (where **nn** = 32 or 40) e.g.

```
[Install]
...
HostApplication=Academy
InformHostApp=C:\pcimages\extevent.exe (example)
InformHostAppCodes=1
...
```

Keyfax will call the `EXTEVENT.EXE` application for various status codes as specified; this is usually set to '1'.

{% hint style="info" %}
**NOTE** If you need to build/deploy a new image (e.g. gold build), for expediency you should be aware that a registry change will have the same effect.
{% endhint %}

The HKEY path will vary depending on the OS.

<figure><img src="/files/WN4nUXbSvqW8c5Vw9AGs" alt=""><figcaption></figcaption></figure>

### Keyfax DLL

The Academy Repair Diagnostics application utilises an Omfax Systems Dynamic Link Library (DLL) called Keyfax.DLL, this is usually found in a shared Academy folder.

However, this file has been deployed by a previous Academy installation and may be corrupt (we have found this to be the case at some Academy customer sites) and should be replaced by that installed by the Keyfax installation in the `Windows\system` folder under Win9x or `WinNT\System32` under NT\Win2k.

The symptoms experienced with the corrupted copy, are recognisable when a repair script is completed in Keyfax, the submit button is clicked and the Academy Housing does not read the exchange XML file.

<figure><img src="/files/m2uo5Lt1tqqI8WGdI20W" alt=""><figcaption></figcaption></figure>

This DLL should then be configured under the ‘II\_LIBU3GL' environment variable in the Academy Launcher: This should be appended to the existing data, with a semicolon delimiter: If problems persist, and it is suspected to be the Keyfax.dll component, contact the author of this document for further assistance.

### Add Keyfax Users

It will be necessary for users to be set up within Keyfax to allow the Academy Repair Diagnostics application to launch Keyfax without a Keyfax login dialog being displayed. For each Academy user requiring access to Keyfax, add their user details in the Keyfax Administrator Tools, e.g.

<figure><img src="/files/7B5BjvlmRGKsPRf3wAnE" alt=""><figcaption></figcaption></figure>

Once completed, click on the Security tab, complete this form then click ‘Submit'. You can assign users to ‘Admin Security' or ‘Admin Scripts' if required, this will allow the users to have access to the Administrators Console as well as the Keyfax client application.

### Testing the Integration between Academy and Keyfax

When configuration is completed, the Academy Repair Diagnostics application will have a new **Globe** icon on it's ‘Repair History' screen. If the globe is not present or is greyed out, check the T[roubleshooting](/integrations/host-systems/capita/capita-housing-academy/troubleshooting.md#the-globe) page.&#x20;

<figure><img src="/files/mAYjxoPSBuRAS8JqfTXY" alt=""><figcaption></figcaption></figure>

Upon clicking the button on the Repairs History screen, Keyfax will be invoked and the tenant's name would be passed across to the Repair Diagnostics application and appear in the top of the screen:

<figure><img src="/files/NIMllMfVaPBUU4EHjAM6" alt=""><figcaption></figcaption></figure>

The user will be taken through a Repair Diagnostics script. Once a script is completed, a results screen will be displayed, on submission the generated repair data will be returned to Academy.

The Academy system will first check if the passed jobcode/schedule code is a **Pre-Defined Repair Request**.  If a PDRR has been found, the system will take the user to the Fast Create screen.&#x20;

However if a PDRR has not been found, the system will try to locate a normal jobcode/schedule of rate code in Academy Housing.  In case it is found, the system will take the user to the **Create Works Order** screen. The user will be required to enter the necessary details to enable the repair to be logged, and the Work Order Lines screen will be populated with the schedule of rate code. &#x20;

### Fast Create

Below is an example for a repair that has been set up on the Housing system as a PDRR, and to be logged via Keyfax Repair Diagnostics.

In this example PL003 has been set up on the Housing system as a Pre-Defined Repair. The user will be presented with the Fast Create screen, and can make amendments if required prior to saving the repair.&#x20;

<figure><img src="/files/Pi5YfH43fC5cs7ypgtRI" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/c0q5bDicEMvkFf5B0GBj" alt=""><figcaption></figcaption></figure>

**PDRR for PL003**:

<figure><img src="/files/imD0fEWVEJFEcTLRtnb6" alt=""><figcaption></figcaption></figure>

### Long Create

Below is an example for a repair that has been set up on the Housing system as a Schedule of Rate, and to be logged via Keyfax Repair Diagnostics.

<figure><img src="/files/Gi7QrsgMcOYP3A9ZJlIw" alt=""><figcaption></figcaption></figure>

In this example **630713** has been set up on the Housing system as a SOR item. It has not been set up as a Pre-Defined Repair.

The user will be presented with the Create Work Order screen, and can make amendments if required prior to saving the repair. The Work Order Lines will automatically be populated with the SOR item number.

<figure><img src="/files/IRy7cGHl85Lc7sV21oQ2" alt=""><figcaption></figcaption></figure>

### Create Works Order

<figure><img src="/files/lCo6H61EMWDTjfZu4dh4" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/hoUS7agNlaUU4R18WMDH" alt=""><figcaption></figcaption></figure>

### Academy Repairs Logging Process (Version 11 and greater)

The following screenshots demonstrate the process of raising a repair in the Academy system (Version 11 and greater).&#x20;

**Fig 1.  Repairs History Screen**.  Showing history of all repairs on the property.  At this stage you would select Keyfax by selecting the 'Globe' icon at the top left.

<figure><img src="/files/349PzeEdFpDMQDb3uINc" alt=""><figcaption></figcaption></figure>

**Fig 2. Create Works Order**.  On completion of the Keyfax screens this screen appears, populated with the information generated by Keyfax.  Any extra info, such as the source of the call, may be added at this stage.

<figure><img src="/files/TcNIySloluTQEVlJgEwR" alt=""><figcaption></figcaption></figure>

**Fig 3. Works Order**.   On saving the Create Works Order screen above a Works Order is created.

<figure><img src="/files/qXn6lU9jj1J2y1bGuMbL" alt=""><figcaption></figcaption></figure>

**Fig 4. Works Order Lines**.  The Schedule of Rates items are appended to the Works Order.&#x20;

<figure><img src="/files/HZaHnFQo2PSdG3UYnLxB" alt=""><figcaption></figcaption></figure>

**Fig 5.  SOR Search.**  Additional SOR items may be added to the Works Order at the time of order creation, or as Variation Orders.

<figure><img src="/files/8MzprlEd8dgBl4IO6CPT" alt=""><figcaption></figcaption></figure>

**Fig 6.  Repairs Stage History screen.**  Shows the progress of the repair from record creation onwards.  Numerous actions are system generated, other user-defined actions may be added, e.g. Awaiting Materials, etc.&#x20;

<figure><img src="/files/u6J5nlm6ZkpQ6lWIRGYR" alt=""><figcaption></figcaption></figure>

### Possible system-generated warnings invoked during repair logging (V11)

<figure><img src="/files/S3A8woPVzVFaiGLi4LrM" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/f0l5lkc91lZTnGXR8Hfg" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/nWbkt0UpQEoEAvd9nXVX" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/eAqiUvj5SWbTV6MmMpDC" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/OovyCIj5GOXDK3s8nF2j" alt=""><figcaption></figcaption></figure>

<figure><img src="/files/Vc1u6mXg0FA0Tny2gSXi" alt=""><figcaption></figcaption></figure>

### Customer Satisfaction Reporting (V11)

**Fig 13.  Customer Satisfaction Recording screen**.  Response Questions and Replies may be user-defined:p&#x20;

<figure><img src="/files/ZRCJ2Mqb3S2H2QRUKkmy" alt=""><figcaption></figcaption></figure>

**Fig 14.  Notes**.  Notes Screens are generic throughout the Academy Housing application, identified by Note Type – e.g. Person Notes; Tenancy Notes; Repairs Notes, etc. and specific Note Codes – e.g. Advice Notes; Warning Notes; Telephone Notes; Asset Notes, etc.

<figure><img src="/files/elZfo1TAnvgzEua1g8AQ" alt=""><figcaption></figcaption></figure>


---

# 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/capita/capita-housing-academy.md?ask=<question>
```

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.