MIS-AMS - SQLactiveH (CRM & Repairs) - Exchange process

Document data
Document Date: 30 October 2005 - revision 2
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

Keyfax exchange process with MIS-AMS SQL ActiveH CRM & Repairs.

The MIS-AMS SQL ActiveH Repairs and CRM applications have integration code to support the Keyfax ActiveX control.
The basic principles utilised in the exchange process are as follows:

The numbered steps above are explained in more detail below:

  1. The MIS-AMS SQL ActiveH application receives a call from a tenant or caller.
  2. The MIS-AMS SQL ActiveH application generates a 'CGateway' object which holds a 'Repair Request' and methods to create Inspections, Tasks and associated MIS-AMS CRM objects.
  3. The MIS-AMS SQL ActiveH application initiates a Keyfax request by creating an instance of the Keyfax ActiveX control (KeyfaxMIS.ocx) and passing it the 'CGateway' object to it.
  4. The Keyfax ActiveX control (KeyfaxMIS.ocx) in turn passes this object to the Keyfax3.dll for processing Keyfax start-up requirement. This begins the synchronous execution of Keyfax, which prevents the user from returning to the MIS-AMS SQL ActiveH application until the Keyfax script is completed or cancelled.
  5. The Keyfax ActiveX control determines the CGateway objects source. If from the MIS-AMS SQL ActiveH CRM, then Keyfax will allow Frontline scripts to jump to Repair Diagnostic scripts.
  6. MIS-AMS provide permissions for the Keyfax3.dll to access their SQL ActiveH database, and include an OLEDB connection string within their 'CGateway' object for the Keyfax3.dll to lookup specific information required in the exchange process. Keyfax3.dll interrogates the CGateway object (using the MISexchange.xml<MapIn><MISRequest> instructions) to generate the initial startup commands.
  7. Keyfax is then launched (in Repairs Diagnostic or Frontline mode) within a window encapsulated in the Keyfax3.dll.
  8. Upon completion of a Keyfax script, an export XML packet is generated. This is enriched with additional instructions for use by Keyfax3.dll to pass back to the MIS-AMS SQL ActiveH application OCX a 'CGateway' object.
  9. The Keyfax3.dll uses the <MapOut><MISTask> instructions from the MISexchange.xml file to generate MIS-AMS Task objects and assign their properties.
  10. Once all the <MapOut><MISTask> instructions are completed, the Keyfax3.dll ends the synchronous process and passes back focus to the MIS-AMS SQL ActiveH application.
  11. The MIS-AMS SQL ActiveH application displays the resulting repair or tasks from Keyfax.