Establishing a Connection

Configure a Connection Profile

From the CData ribbon, click Get Data and select From SuiteCRM connection/s to launch the CData Query window. To setup a new connection, you will have to click the New SuiteCRM Connection button. Here you can set the connection settings, test the connection, and save the connection profile.

Connecting To SuiteCRM V4.1 API

You can connect to SuiteCRM data via the V4.1 API by simply setting the following connection properties:

Schema: Set this to suitecrmv4.
Url: Set this to the URL associated with the SuiteCRM application, for example http://suite.crm.com.
User: Set this to the user associated with the SuiteCRM account.
Password: Set this to the password associated with the SuiteCRM account.

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

Connecting To SuiteCRM V8 API

Before Connecting

Before you connect to SuiteCRM V8 API you will need to first configure it in your SuiteCRM instance. The API can be configured in SuiteCRM version 7.10+. To configure the API, please follow the steps written in the SuiteCRM JSON API docs, found here: https://docs.suitecrm.com/developer/api/developer-setup-guide/json-api/#_before_you_start_calling_endpoints .

The SuiteCRM V8 API uses OAuth2.0 as its main method of authentication using 2 types of grant type, password or client credentials. Please see Using OAuth Authentication for a guide on how to connect with OAuth.

Connection Properties

The Connection properties describe the various options that can be used to establish a connection.

Managing Connections

After successfully authenticating to SuiteCRM you will be able to customize the data you are importing. To learn more about this, see Managing Connections.

Excel Add-In for SuiteCRM