ODBC Addin Guide


This Addin Guide contains proprietary information and shall not be used, disclosed, reproduced or shared, in whole or in part, without the prior written consent of the application developer.Should you need to do this or require further clarification, please contact the CRM Connect support desk quoting your serial number.




This page will guide you through configuration and basic use of the CRM Connect ODBC Add-in.It is expected that you are already familiar with the Address Book, Call History and Preview window, and the basic concepts of integration and screen popping using the Add-ins.See the 'User Guide' for these topics.


CRM Connect must also be installed already with the initial configuration completed.If this is not the case, please see the 'Technical Installation Guide' or consult your system administrator.


Configuration

The ODBC Add-in configuration is split into three groups:Connection, Fields, and Show Contact.


Connection

ODBC integration configuration screen


On the Connection group, first select the ODBC data source to use from the Data source name dropdown list.You need to have created the data source from ODBC Configuration first.

The connection string will be shown, allowing you to edit it if necessary.


If the data source requires a username and password, enter them in the relevant boxes.


From the 'Table/Query' list, select which table in the data source contains the contact data you wish to use.


If you need to you can enter your own custom SQL statement in the Advanced box.You might do this for example if phone numbers are stored in a different table to the table that contains contact names and you need to do a join.

The Left and Right boxes allow you to enter custom identifier quote characters.  These are dependent on the type of ODBC driver your data source uses and are usually square brackets or quotes.


The Parameterize queries box should be left checked, only turn this off if your ODBC driver does not support parameterized queries.This is a security feature.


If you want to check that you have selected the correct table or query, you can click the Test button to see the first few records from the table or query that you selected.


Fields

On the Fields group, you will tell the Add-in what the fields in your ODBC directory represent.For example, you might have a field in your directory named ACCOUNT_NUMBER which actually represents the unique Id of the contact.

ODBC integration Fields configuration screen

To map an Add-in field to one of your directory's fields, double-click it in the list or highlight the Add-in field and click the 'Edit…' button to open the 'Edit field' window.


Edit field window

Then, from the 'Database field' dropdown box, select the field in your directory which corresponds to the Add-in field you're editing, and then click 'OK'.

The only Add-in fields you need to map are Id, ContactName and/or CompanyName, plus as many Phone fields as you have in your directory.You can also optionally map the City and Email fields so that they appear in search results.


Edit field windowAdd button

If your contacts have more than three phone numbers or you want to include some other fields from your directory, you can add them by using the 'Add…' button.Type the name you want the new Add-in field to be called into the 'Internal field' text box.Then, select what the field represents from the 'Type' dropdown box.Finally, select the directory field to map to the new Add-in field and click 'OK'.


Guess button

The 'Guess' button will attempt to guess which fields in your data source map to which fields in the Add-in (based on the name of the field).


Show Contact


So far, you have configured the ability to search for contacts from the Address Book and to see the name of people calling you in the Preview window.


ODBC integration Show Contact configuration screen

If you want screen popping, so that you can actually go to the contact in your database program from the Preview window or the Address Book, you need to configure the Show Contact action to tell the Add-in what to do when you want to show the contact.


The Add-in will run the program or go to the URL that you specify and pass it the command-line parameters that you specify.


Use the 'Browse…' button to select the program to run or, to launch a web page, enter its URL into the 'Program to run' text box.


In 'Parameters' you can enter the Add-in fields to pass to the program or web page you selected above.For example, you could enter '%Id%' to pass the value of the field mapped to Id to the command-line of the program you selected.If you entered a web page URL in 'Program to run', the parameters are appended to the URL.

Testing

Integration test results

To test if the configuration worked, enter a phone number from your ODBC account into the 'Telephone' box in the 'Integration test' area and click the 'Search' button.The results will be displayed after a few seconds.

If the test does not work, go to the 'Log' page of configuration and turn on logging, then do the test again and see if there are any errors in the log.