# Introduction

The official Keyfax & Civica CX integration developed by Omfax Systems allows call centre advisors to quickly and easily generate repair requests, works orders, task lines and / or inspections within Civica CX simply by walking through a Keyfax script 

The video below demonstrates the basic advisor journey...

{% embed url="<https://youtu.be/ycPyCKNnqnU>" %}

### How the Integration Works

#### 1. Launch Page

{% hint style="info" %}
**TIP** The launch page can be skipped entirely if you already hold the Civica CX asset reference within your CRM or housing management system. Contact us for details.&#x20;
{% endhint %}

The custom launch page requires an Asset Reference and optional Contact Reference. Upon submission this launch page makes a query into the Civica CX web services to validate the supplied asset and / or contact reference and obtain the internal Civica CX identifiers which will be passed into Keyfax as part of the start-up data.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FhKZKU0QTiu9nlRzXSsC0%2F235912411-e836b0f8-d30c-49b8-842b-29a9dc0eb2b0.png?alt=media&#x26;token=d6b4f0fc-e8e4-4f93-acbb-7ab501b4169e" alt=""><figcaption></figcaption></figure>

If validation succeeds then the above launch page loads the Keyfax start-up XML template for the supplied Keyfax configuration and populates the `<AssetID/>` and `<ClientID/>` elements with the internal identifiers obtained from Civica CX for the asset and contact references.

The above launch page then posts the constructed start-up XML to our `KeyfaxWS.asmx/Startup` web service to get back a launch URL and GUID. If successful the above launch page will then simply redirect the user to the launch URL. If any errors occur the user will be presented further information on the nature of the error on the launch page.

The above launch page by default will use the Keyfax master configuration however as with most pages you can also supply a custom `co` and `mo` query string parameter to Dynamically set the Keyfax configuration. I've tested this with both staff and online configurations and everything works as expected.

The above launch page also passes in a custom `ReturnUrl` within the Keyfax start-up data to return the user back to `/Interview/CivicaCX/Completed'/` after completing the Keyfax script so a Civica CX repair request can be created.

If the asset reference and / or contact reference are not known advisors can optionally use the Civica CX address search provided as part of the Keyfax & Civica CX integration to easily launch Keyfax with all the Civica CX data as shown on our [start-up-data](https://docs.keyfax.biz/integrations/host-systems/civica/civica-cx/start-up-data "mention")page. The address search can be seen below\...

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FWU8aAPMCxnbV0dZ9s5dO%2Fimage.png?alt=media&#x26;token=8474a0c5-9464-4301-a52e-b803d8ac8f98" alt=""><figcaption></figcaption></figure>

#### 2. Keyfax Script

The user / advisors proceeds through the Keyfax script as normal.

#### 3. Completed Page

After completing the Keyfax script the user will be redirected back to a custom completed page specifically for the Civica CX integration. This completed page takes the GUID provided by Keyfax and queries for Keyfax results via `KeyfaxWS.asmx/GetResults`. If returns are returned successfully the completed page will then load the CxMapping.xml file and attempt to map certainly export XML elements with specific properties for a repair request within Civica CX.

Once mappings have succeeded and the repair request created successfully the user would be presented with the following...

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FeyJqvPr0iaTc9k1DyhHm%2F239226658-d0c5b2b1-2ebf-4845-8da2-e6b5b34c10cb.png?alt=media&#x26;token=0ebc082e-c3f5-4ed1-9481-1b35c4fef2e1" alt=""><figcaption></figcaption></figure>

{% hint style="info" %}
**TIP** If an inspection is created as a result of the repair within Civica CX the inspection ID will also be presented on the Keyfax completed page.&#x20;
{% endhint %}