> 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/integrations/host-systems/activeh-desktop/mis-configuration/settings.md).

# Settings

Before Keyfax is used with the MIS-AMS SQL ActiveH Repairs, various settings need to be applied to the MIS-AMS installation. This is done via MIS-AMS SQL ActiveH Desktop and Repairs.

The following information give a walk-through of the various steps required to complete the configuration:

1. The MIS-AMS SQL ActiveH Desktop application is usually accessible from a desktop shortcut icon on the client PC. Click this icon to launch the MIS-AMS SQL Active Desktop.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FzkhuQ7muBhodLVQuuzvI%2Fimage.png?alt=media&amp;token=ac470387-1f99-4bda-88cd-99fd96372f6f" alt=""><figcaption></figcaption></figure>

2. If the MIS-AMS SQL ActiveH installation has more than one instance available, a "configurations" dialog will be displayed (see right). This may contain Live, Test and Training versions, all of which will need to be configured independently.<br>

   For this walk-through, the "Live" instance will be selected - Click the "OK" button to continue.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2Fb9nPrapUCYSuhP8lS92T%2Fimage.png?alt=media&amp;token=ff3843ad-acb7-4327-ab06-d60cc2da9e2e" alt=""><figcaption></figcaption></figure>

3. A login dialog will prompt you for a valid username (ID) and password.<br>

   It is important that a MIS-AMS SQL ActiveH user account with administrative access to edit configurations is used for this process. In this case the "MIS" user account, once the details are entered - Click the "OK" button to continue.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FdkSxOWNIaOttR0CAGt3k%2Fimage.png?alt=media&amp;token=080a85f2-af24-4f9f-863d-2ef75ffad0fa" alt=""><figcaption></figcaption></figure>

4. The Main MIS-AMS SQL ActiveH Desktop window is displayed (see right). This give access to the required configuration screens.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2F8IHIOG4jcowvpSs3WktR%2Fimage.png?alt=media&amp;token=87ff90f0-e658-4f35-b104-df618f9a3c5d" alt=""><figcaption></figcaption></figure>

5. From the Main MIS-AMS SQL ActiveH Desktop window, select the "Options.." item from the "Tools" menu (see right).

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FYnfVygtSneuk08KmOTfw%2Fimage.png?alt=media&amp;token=344659a7-0ac7-474e-a25e-9ed577aed963" alt=""><figcaption></figcaption></figure>

6. The "Options" screen has a series of settings which can be set on "tabs". The "Repair Finder" tab should be selected, and the details should be entered as follows:\
   \
   **Prog ID:** the class name for the Keyfax OCX control used in interface ("KeyfaxEx.Keyfax")\
   \
   **Caption:** The text used for the Keyfax hyperlink button in the CRM (i.e. "Keyfax"), although not necessary, with Repairs. \
   \
   **Database:** The name of the Keyfax database for MIS-AMS SQL ActiveH CRM usage (format: "KF\_\[company name]\_32" -*should be on the same SQL Server instance as the SQL ActiveH database*)

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FMsxuDmNsaC6skr7rNkGU%2Fimage.png?alt=media&amp;token=5983962d-7eff-4bb7-9ce4-8d4164a21a78" alt=""><figcaption></figcaption></figure>

7. While in the "Options" screen, the "Integration" tab should be selected, and the "Repair Finder" item should be checked. - This enables/disables the Keyfax hyperlink button in the CRM.<br>

   Click the "OK" button to save any changes.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FbkDHArTTRVtdW5pZqBSK%2Fimage.png?alt=media&amp;token=a44a9c3e-5f5e-4cdf-ad9e-fb14e89e469c" alt=""><figcaption></figcaption></figure>

8. Note: In later versions of the MIS-AMS SQL ActiveH Desktop application, the Options screen has been revised. The screen capture on the right is from version 5.5.0.<br>

   This version now has the "Repair Finder" settings on the the "Integration" tab.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FgxB69Gt4AoqlBwArsDmG%2Fimage.png?alt=media&amp;token=c96f5b07-6bbc-4f53-a3a5-3118065c03a3" alt=""><figcaption></figcaption></figure>

### Additional Configuration

Once the MIS-AMS SQL ActiveH Desktop configuration is complete, additional configuration is required in the MIS-AMS SQL ActiveH Repairs module.

The following information gives a walk-through of the various steps required to complete the configuration:

1. The MIS-AMS SQL ActiveH Repairs application is usually accessible from a desktop shortcut icon on the client PC. Click this icon to launch the MIS-AMS SQL ActiveH Repairs, and login as an administrative user (as indicated above).
2. From the Main MIS-AMS SQL ActiveH Repairs window, select the "Options.." item from the "Tools" menu (see right).

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FKTrV5B2xfZTn8IJ1omZQ%2Fimage.png?alt=media&amp;token=c46bdb7d-0eab-45f5-8cfd-5ed3accdc469" alt=""><figcaption></figcaption></figure>

3. The "Options" screen has a series of settings which can be set on "tabs". The "Job Fax " tab should be selected, and the details should be entered as follows:\
   \
   **Enable Job Fax :** the checkbox should be checked. \
   \
   **Exchange Start Up :** This is a series of command line parameters, which instruct the Keyfax OCX to establish a communications interface with the host application. This should be:\
   /S:XML /E:XML /V:MIN /M:RD. \
   \
   **Global Password :** The Keyfax Global password should be set to allow Keyfax Repairs Diagnostic to skip user password validation during operation. This password can be obtained by request from Omfax.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2Fcuo9GJ5ru70d7gzVUNf7%2Fimage.png?alt=media&amp;token=a7375fe4-9d50-4238-826f-c3f0af7ab710" alt=""><figcaption></figcaption></figure>

### Launching Keyfax from MIS-AMS SQL ActiveH Repairs.

Once the MIS-AMS SQL ActiveH Desktop and repairs modules have been configured the Keyfax application can then be launched from the Repairs module. The following information give a walk-through of the various steps required to test this configuration:

1. The MIS-AMS SQL ActiveH Repairs application is usually accessible from a desktop shortcut icon on the client PC. Click this icon to launch the MIS-AMS SQL ActiveH Repairs, and login (as indicated above).
2. From the toolbar, select the "Requests" item from the "Tasks" menu icon drop-down (see right).

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FJUoLlO6oN2b3Jy3f5BQ5%2Fimage.png?alt=media&amp;token=faee9b3b-d30b-4642-8274-6aa605fea647" alt=""><figcaption></figcaption></figure>

3. A new "Repairs Request" will be created, which will require an asset to be selected (or looked up) before Keyfax can be launched.<br>

   Click the "New" icon (left most icon on toolbar), which will launch the "Asset Lookup" window.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2Fk8G8jqZosIKV69Uz2INv%2Fimage.png?alt=media&amp;token=f1f32a6c-c9f9-4e21-a0e8-f301748c0254" alt=""><figcaption></figcaption></figure>

4. The MIS-AMS SQL ActiveH "Asset Lookup" window is displayed (see right). Enter in search criteria to select an Asset by it's address, postcode, type or current tenant details.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FZwHVtmlKYpymELqAdpxS%2Fimage.png?alt=media&amp;token=e49b6ef9-1c65-4405-b44b-83c8342fd296" alt=""><figcaption></figcaption></figure>

5. Once a tenant is selected from the "Asset Lookup" window, it will close and populate the "Repairs Request" window (see right).<br>

   Click the "Add Task " icon (left most icon on toolbar above the Tasks pane), which will launch the "Task Line" window to capture SOR and other repair details.

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FsgIGFNnFFmpXzsnLHmd0%2Fimage.png?alt=media&amp;token=6251d633-8d3e-4098-9b81-2e7b3a31ea30" alt=""><figcaption></figcaption></figure>

6. You will now see a "Keyfax" button (Blue "K" icon), next to the MIS-AMS SOR Lookup button (magnifying glass icon). This will launch Keyfax Repairs Diagnostic to capture SOR codes (see right).

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FmdrI2aytsVg5jXPH5nI9%2Fimage.png?alt=media&amp;token=b3aabd77-9d52-4c53-a97b-0ef5e908cfa6" alt=""><figcaption></figcaption></figure>

7. When the "Keyfax" button is clicked a "JobFax Communications" window will be displayed. This remains on screen, with Keyfax status information displayed until the Keyfax scripting process is complete (see right).

<figure><img src="https://2882349412-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F-MARm6St_qFGM52R3pBa%2Fuploads%2FkOQS6wrKNvYLuJsFvjXb%2Fimage.png?alt=media&amp;token=1c41311c-abf8-46b2-8f2b-a78d356e98f1" alt=""><figcaption></figcaption></figure>

8. Once Keyfax closes, the SOR code will be returned to the "Task Line " window, where the Priority, Unit Of Measure and Quantity, Job Type and other required information should be completed manually.
