macOS DSN Configuration

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

Minimum macOS Version

The CData ODBC Driver for SuiteCRM 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 SuiteCRM/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 SuiteCRM

Requirements for connecting to SuiteCRM differ, depending on which version of the API your site is running.

SuiteCRM V4.1 API

To connect to SuiteCRM data via the V4.1 API, set these connection properties:

Schema: suitecrmv4.
Url: The URL associated with the SuiteCRM application. For example, http://suite.crm.com.
User: The user associated with the SuiteCRM account.
Password: The password associated with the user of the SuiteCRM account.

Note that retrieving SuiteCRM metadata can be expensive. We recommend that you store the metadata locally, as described in Caching Metadata.

SuiteCRM V8 API

SuiteCRM V8 uses the OAuth2 authentication standard. Before you connect to SuiteCRM V8 API, you must ensure that is it properly configured to provide the OAuth2 private and public keys. For further information, see the SuiteCRM Developer Guide API V8 setup instructions.

Authenticating to SuiteCRM V8 API

The SuiteCRM V8 API uses OAuth2.0 as its authentication mechanism, based on either of two grant types: PASSWORD and CLIENT.

Authentication via OAuth requires the Schema to be set to suitecrmv8, and the creation of a custom OAuth application, as described in Creating a Custom OAuth Application.

Client Credentials Grant

To connect to SuiteCRM V8 API, set these properties:

Schema: suitecrmv8.
AuthScheme: OAuthClient.
OAuthClientId: The client key returned during custom OAuth application creation. (See Creating a Custom OAuth Application.)
OAuthClientSecret: The client secret returned during custom OAuth application creation (See Creating a Custom OAuth Application.)
URL: The base URL of your SuiteCRM system. For example, https://suitecrmhost/.

Password Grant

To connect to SuiteCRM V8 API, set these properties:

Schema: suitecrmv8.
AuthScheme: OAuthPassword.
OAuthClientId: The client key returned during custom OAuth application creation. (See Creating a Custom OAuth Application.)
OAuthClientSecret: The client secret returned during custom OAuth application creation. (See Creating a Custom OAuth Application.)
User: The user's username.
Password: The user's password.
URL: The base URL of your SuiteCRM system. For example, https://suitecrmhost/.

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 SuiteCRM"
sudo ./uninstall.sh

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