3rd Party Integration - Repairs Online (ROL)
General
Keyfax Repairs Online (ROL) differs from the core Keyfax Repair Diagnostics product in the following ways:
- Initial selections are made via images/hotspots rather than tree-view menu
- Optional login page with validation e.g. valid tenancy reference
- Optional address selection (e.g. where postcodes are supplied)
- Optional 'Preferred appointment' page
- Email generation (to tenant and housing dept)
- Host integration (webservices/XML)
- Styling
Launching Repairs Online (using Login Page)
Repairs Online is launched by calling a URL (e.g.):
http://dev.touch-base.com/keyfax32/main.asp?co=KFRDROL&ROLLogout=1
Fixed parameters are:
- co: Company code. This determines which Configuration Settings to use; the Company Code will normally be predefined by Omfax Systems Ltd.
- ROLLogout=1. System requirement.
A Login page (tailored to suit your needs) will be presented, typically capturing the following information:
- Tenancy Reference (with optional validation, e.g. database lookup)
- Name
- Address
If required, additional fields/validation can be provided.
Launching Repairs Online (bypassing Login Page)
Call the following URL (e.g.):
http://dev.touch-base.com/keyfax32/main.asp?co=KFRDROL&ROLloggedin=1&oTenantID=8861728&oPostCode=BH20%207XX&oName=Bertrand%20Smythe
Fixed parameters are:
- co: Company code. This determines which Configuration Settings to use; the Company Code will normally be predefined by Omfax Systems Ltd.
- ROLloggedin=1: System requirement
Variable parameters are:
- oTenantID: tenant reference
- oAddress1: 1st line of address
- oAddress2: 2nd line of address
- oPostCode: post code
- oName: tenant name
- oReturnURL: specifies the return URL. Optional. If not present an agreed URL is called.
- oGUID: optional Globally Unique ID. If not supplied, Keyfax will generate a GUID and return this to the caller
Note that there are no restrictions on length or content of the parameters above (other than reasonableness and maximum URL restrictions, approx. 2000 characters).
Note that additional items can be passed and these will be delivered in the export XML, e.g. a predefined Repair Request No.could be passed in a new parameter oRepairNo
Processing XML results
Upon completion or cancellation of a script , the system will redirect to the URL specified on the querystring or, if not present, to the URL held for the specified Company.
The following parameters will be returned:
- status=1: script completed normally
- status=2: script was cancelled
- guid: unique ID used for retrieving XML results (see below)
Following normal completion, XML results can be requested via the following URL (e.g):
http://dev.touch-base.com/keyfax32/status.asp?co=KFRDROL&xml=1&SaveXML=1&guid=1327D910-F106-7F5A-1F851C9B76DBCE39
Fixed parameters are:
- co: Company code. This determines which Configuration Settings to use; the Company Code will normally be predefined by Omfax Systems Ltd.
- xml=1: System requirement
- SaveXML=1: system requirement
- guid: original GUID passed to Keyfax or auto-generated GUID
ROL-specific details follow the normal Repair Diagnostics Export XML, e.g.:
<ROLDetail><oTenantID>8861728</oTenantID>
<oName>Bertrand Smythe </oName>
<oName>BH20 7XX </oName>
<oRepairNo>177366-D3</oRepairNo>
<Appointments><![CDATA[Monday: 0800 - 1200<br/>Wednesday: 1000 - 1400<br/>Wednesday: 1200 - 1600<br/>Friday: 0800 - 1200<br/>]]></Appointments>
</ROLDetail>
Note that Appointments data (if required) can be styled as required .