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

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.

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/.

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.

See Also

• Querying Data: Use the data selection wizard to pull data into a spreadsheet. You can also configure scheduled data refresh here.
• Using the Excel Add-In: Find other ways to interact with SuiteCRM data, such as using the available CData Excel Functions.