This section shows how to set up ODBC connectivity and configure DSNs on macOS.

Minimum macOS Version

The CData ODBC Driver for SugarCRM driver requires macOS Sierra (10.12) or above.

Licensing the Driver

In a terminal, run the following commands to license the driver. To activate a trial, omit the <key> input.

cd "/Applications/CData ODBC Driver for SugarCRM/bin"
sudo ./install-license.sh <key>

You'll be prompted for a name and password. These refer to your name and your machine's password.

Connecting to SugarCRM

To establish a connection to SugarCRM, set URL to the URL associated with your SugarCRM account in the form http://{sugar crm instance}.com.

Authenticating to SugarCRM

To authenticate the driver to SugarCRM, set the following:

• User: The user of the SugarCRM account.
• Password: The password associated with the SugarCRM user.
• Platform (optional): If you're encountering a login conflict during authentication, set this to one of the platforms that you have created in the SugarCRM UI.

By default, SugarCRM uses the "sugar" client id for authentication, but users can optionally specify the client Id and client secret values of a custom app. See Creating a Custom OAuth Application for more information.

• OAuthClientId: Client Id of your custom OAuth app.
• OAuthClientSecret: Client secret of your custom OAuth app.

Caching SugarCRM Metadata

Note that retrieving SugarCRM metadata can be expensive. It is advised that you store the metadata locally as described in Caching Metadata.

Uninstalling the Driver

The easiest way to uninstall the driver is to open a terminal and run the included uninstall.sh script, located in the installation directory. For example:

cd "/Applications/CData ODBC Driver for SugarCRM"
sudo ./uninstall.sh

Note: The script needs to be run from the installation directory.