Exchange process
Keyfax exchange process with Northgate Sx3 Housing.
Last updated
Keyfax exchange process with Northgate Sx3 Housing.
Last updated
The Sx3 Housing applications have integration code to support the Keyfax web service. The basic principles utilised in the exchange process are illustrated below. Note that KFnnWS refers to either the Keyfax 3.2 or Keyfax 4.0 version of the Web Service.
The numbered steps above are explained in more detail below:
The Sx3 Housing application receives a repair request call from a tenant or caller.
The Sx3 Housing application calls the Sx3 Integrator to create XML instructions to pass to Keyfax. This includes details of tenant, their property (asset), repair history and planned maintenance.
The Sx3 Integrator adds a unique session ID, and wraps the XML data in a SOAP envelope and passes to the Keyfax web service.
The Keyfax web service (KFnnWS where n = version no.) receives the XML SOAP request and extracts the Keyfax request data.
The Keyfax web service puts the Keyfax request data in the Keyfax database, using the Sx3 unique session ID as the key.
The Keyfax web service validates the XML data, and returns a status in the SOAP request response.
The Sx3 Integrator processes the SOAP request response, and if OK, will pause the Sx3 application while the Keyfax is processed.
The Sx3 Integrator loads an Internet Explorer window to the Keyfax URL to begin the diagnostic script.
The Keyfax application guides the user through a repair diagnostic.
Keyfax completes and generates repair data to export, or the user cancels a script / exits the application.
Keyfax builds a return XML packet, and includes the Keyfax status (1 = Complete, 2=Cancelled, 3=Exited).
Keyfax wraps the XML packet in a SOAP envelope and sent it to a Sx3 web service, where the Sx3 KEYFAX_DATA API will process the results.
The Sx3 Integrator validates the XML packet, and returns a validation response to Keyfax for logging.
The Sx3 Housing application receives focus back from the Integrator and if Works Order data is received; displays a new Works Order populated from Keyfax data.
