MIS-AMS SQL ActiveH Repairs configuration

Document data
Document Date: 20 November 2006 - revision 1
Keyfax version : 3.1.0.13 (or greater)
Software required: SQLactiveH CRM/Repairs 5.3+ / Keyfax 3.1.0.13+
User skill requirements: NT administration. SQL Server DBA. IIS configuration. NT security policies. MSXML editing.
Author: Technical Services keyfax@touch-base.com

Configuration of Keyfax within the MIS-AMS SQL ActiveH Repairs.

Important notice: At the time of writing, MIS-AMS have not completed full integration of Keyfax Repairs Diagnostic with the SQL ActiveH (responsive) Repairs module.

Although Keyfax Repairs Diagnostic can be launched, the information captured from the Keyfax exported data is extremely limited. At present, only the SOR codes generated are captured. No priorities, additional information, inspections etc are read, and as a result, repair requests must be completed manually in the SQL ActiveH Repairs module. For this reason, Omfax recommend that the MIS-AMS SQL ActiveH CRM is used, which is fully integrated with Keyfax Repairs Diagnostic.

This document shows a guide for configuring SQL ActiveH Repairs for use with Keyfax Repairs Diagnostic, only if CRM is not available. Omfax are committed to working with MIS-AMS to complete the Repairs integration at the earliest possible date.

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 the 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.

 

 

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.

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

 

 

3.       A login dialog will prompt yo for a valid username (ID) and password.

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.

 

 

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

 

 

 

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

 

 

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)

 

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.

Click the "OK" button to save any changes.

 

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.

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

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 give 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).

 

 

 

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.

 

 

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).

 

 

 

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

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

 

 

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.

 


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

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.

 

 

 

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).

 

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).



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.