Introduction
Details related to the Keyfax & ActiveH Customer Portal integration.
Last updated
Details related to the Keyfax & ActiveH Customer Portal integration.
Last updated
The MIS ActiveH Customer Portal module (formerly known as TIPS) is a public facing portal that integrates with Keyfax for the purposes of raising Repairs and Enquiries.
Through a secure online account, registered users are now able to report and view repairs, view account statements, view and request changes to personal details, report anti-social behaviour and pay their rent.
The portal integrates with the ActiveH Customer Relationship Management (CRM) module, meaning that contact centre staff gain an instant view of requests as they are raised, and are able to respond instantly and more effectively to online repair requests and enquirie
Keyfax scripting has been integrated into ActiveH Customer Portal by building support into the existing ‘Custom Forms’ functionality.
A new custom form control has been added to Customer Portal Manager’s Form Designer which allows for the creation of a custom form which will redirect to a script hosted on the Omfax server when launched.
Using the existing custom forms process allows the Omfax script to act as a trigger for the creation of a desktop task or the execution of a workflow process when it is submitted in the same way that custom forms do.
When an Omfax Script control has been added to a custom form, the addition of further controls (with the exception of a custom Response Message) will be prevented, the message shown below will be displayed if attempting to add additional controls:
The ‘Script Selection’ fields allow the user to specify which script will be launched on the Omfax system.‘Mode’ will typically be ‘ROL’ (Repairs Online) and is required, the form load will generate an error if Mode is not specified.
‘Category’ and ‘Topic’ are optional and are used to tell the Omfax system to display a particular sub-category or individual script on startup rather than a generic menu.
A typical value for ‘Category’ might be “Baths, Basins, Sinks” and a typical value for ‘Topic’ would be “Bath”. The ‘Script Options’ section allows the user to specify various options about how the script should be launched.
‘Run on test system’ is just a flag which tells the Omfax server to run this script in a test environment rather than on the live system, useful for testing new scripts.
‘Run as’ defaults to ‘Logged in Contact’ but optionally allows the user to specify the contact_ID of another user and if specified that user ID will be supplied to the Omfax server as the Contact_ID to use when processing the script.
‘Store Uploaded Files in’ allows the user to specify where any supporting photo uploaded during execution of the Omfax script will be stored in ActiveH once they have been retrieved by us.
‘Use Asset’ allows the User to specify a particular Asset ID to be supplied to the Omfax script rather than using the currently selected repairs asset which is the default.
A custom form containing an Omfax script control does not behave in the same way as a standard custom form when launched.
Instead of displaying a rendered form with a ‘Submit’ button the server will use the form settings to construct a request which is sent to the Omfax system and will then redirect the user to the Omfax server to execute the script.
The interaction with the Omfax server uses a web service interface as illustrated below.
These interactions should be invisible to the end user, from their perspective, they will simply follow a link to a custom form on the Tips site and will find themselves redirected to the relevant page in the Omfax site.
When they complete the Omfax script, they are automatically redirected back to the originating custom form on the TIPS site which will process the data returned by the Omfax script and perform the relevant submission actions (Desktop task creation or Workflow execution)
If the user cancels the Omfax script rather than submitting it then they are redirected to the TIPS home page.
In the event that the users session on the ActiveH Customer Portal server times out whilst they are on the Omfax site executing the script, they will be redirected to the Login page when the Omfax script is submitted and after logging in they will automatically be redirected to the custom form and the form submission actions will then execute normally.
Overview of the submission process for a custom form containing an Omfax Script control.
In order to construct the ‘StartupXML’ which is supplied to Omfax as the first stage of the process above it is necessary to have three pieces of information in addition to those specified in the custom form Omfax Script control:
The endpoint URL of the Keyfax Web service
“Originating System Name”
“Company”
For testing purposes, the following values are used:
OmfaxWSEndpointUrl
OmfaxCompanyName
OmfaxOriginatingSystemName
In order to facilitate this three new rows have been added to Webdata_Tips_SYS_SiteSettings_T
To store these values.
Typical format of StartupXML:
The ‘ReturnURL’ will always point to Omfaxhandler.ashx which is a generic handler responsible for handling traffic between the Omfax system and the calling custom form after the initial launch.
Files modified / created
Tips Manager
Tips_Shared/AMS.Tips.Core/Controls/Winforms/
CustomFormOmfaxScript.vb
New Custom Form Omfax Script Control for Tips Manager
Tips_Shared/AMS.Tips.Core/Controls/Winforms/
CustomFormControlsContainer.vb
Modified with logic to ensure only one Omfax control can be added to a page etc
Tips_Manager/Resources/omfaxlogo.jpg
Icon for OmfaxScript button
Tips_Manager/Controls/Forms/WebformEditor
Modified to add support for new OmfaxScript form control
Tips_Shared/AMS.ActiveH.Desktop.Library/
UserTask.vb
Modified to take account of new parameter added by Dave Salerman
ips Website
Tips_Website\Tips_2.0\
OmfaxHandler.ashx
Generic Handler for managing redirects from Omfax server
Tips_Shared/AMS.Tips.Core/Core/Omfax
OmfaxFormSubmission.vb
CSLA object for persisting Form Submission data during the Omfax scripting process
Tips_Website/Tips_2.0/User_Controls/Forms/
uiFormOmfaxScript.ascx
OmfaxScript custom form control – responsible for generating StartupXML and initiating request to Omfax
Tips_Website/Tips_2.0/User_Controls/Forms/
uiCustomForm.ascx
Modified to handle new Omfax script control and handle some submission steps differently if dealing with an Omfax script form
Tips_Website/Tips_2.0/WebConnector/
WebConnectorHelper.vb
Modified to add new security headers required by latest version of WebConnector
Tips_Website/Tips_2.0/Generic_Styles/images/
Spinner.gif
‘Please Wait’ animated gif
Service Reference: KeyfaxWSRef
Pointing to:
(modifies web.config file)
Tips_Website/Tips_2.0/Global.asax.vb
Modifications to handle redirecting of timed out sessions correctly.
Tips_Shared/AMS.Tips.Core/Website/
WebsiteSettingsList.vb
Added new settings to support Omfax integration
Database objects
Stored Procedures:
up_parmins_Webdata_Tips_OmfaxFormSubmission
up_parmsel_Webdata_Tips_OmfaxFormSubmission
up_parmupd_Webdata_Tips_OmfaxFormSubmission
up_parmdel_Webdata_Tips_OmfaxFormSubmission
CRUD procs in support of OmfaxFormSubmission CSLA object
New Table:
Webdata_TIPS_OmfaxFormSubmissions_T
Holds OmfaxFormSubmission data
