MIS-AMS SQL ActiveH Task UDE Interface

Document data
Document Date: 19 October 2006 - revision 1
Keyfax version : 3.1.0.13 (or greater)
Software required: SQL ActiveH 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 the Task UDE Interface within the MIS-AMS SQL ActiveH Desktop.

This topic assumes that the Keyfax User Defined Elements (UDE) have been added to the MIS-AMS SQL ActiveH Desktop configuration. For a full explanation of ActiveH UDE fields and how they are used in conjunction with Keyfax Frontline, see the Keyfax UDE configuration topic - see here.

Before the UDE fields are used (and visible to users) by Keyfax, each defined field must be "mapped" to the Keyfax app_export_sub "Key" items. This is required to only allow MIS SQL ActiveH CRM UDE items to be accessed by Keyfax, that exist, and are configured in each application.

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 may will prompt for a valid username (ID) and password (some configurations will link the login to the users Windows profile, so the login may be bypassed).

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.      We need to open the "UDE Gateway Mapping List" form in the MIS-AMS SQL ActiveH Desktop....

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

 

 

 

5.       The"UDE Gateway Mapping List" screen displays (see right). This displays any existing UDE gateway mapped items.

Now we need to add a new Keyfax UDE item "Addressee04" (see the previous topic where this was added) - to do this we need to click the New button on the toolbar (left hand item).

 

6.       This displays the "UDE Gateway Field Search" screen. This is used to find any UDE items which are awaiting mapping.

As there is only a single UDE item awaiting mapping. As the UDE item "Addressee04" was added to the UDE "Panel 1" which had a caption of "Omfax", entering "Omfax" in the "UDE Panel Description" field then clicking the "Search" button will display a list of matching items (see right).

Note: Only items awaiting mapping will be displayed. If other UDE fields were added, these will also require mapping.

Double-click the required UDE item (or select it and click "Open") to open the "UDE Gateway Mapping (New)" screen.

 

7.       The "UDE Gateway Mapping (New)" screen displays information about the UDE item entered in the UDE "New Fields" screen (see right). At the bottom is a drop-down list of all Keyfax "Keys" (Gateway fields) yet to be "mapped".

Select the "Gateway Field Description" from the drop-down list which matches the "UDE Field Description" and click "OK".

Note: If the drop-down list is not populated, it is likely that all the Keyfax SubAction Keys defined in the Keyfax app_export_sub database table have been mapped. Only unmapped Keys are displayed in the list.

 

8.       The "UDE Gateway Field Search" screen is refreshed, and the new UDE mapping is displayed in the list (see right).

Repeat this process - steps 6 & 7, for each outstanding Keyfax UDE item.

 

Note: Please see the MIS-AMS documentation for more information on mapping UDE fields.