Power BI Connector for SuiteCRM

Build 24.0.9060

Creating the Data Source Name

This section describes how to edit the DSN configuration and then authenticate and connect to SuiteCRM APIs.

DSN Configuration

You can use the Microsoft ODBC Data Source Administrator to edit the DSN configuration. Note that the installation process creates a both a user DSN and a system DSN, as described in Installing the Connector.

Note: The connector stores connection information in the Windows registry. To ensure that the connector can write to the registry, either run Power BI as an administrator or use a User DSN for your connection instead of a System DSN.

User DSN

Complete the following steps to edit the DSN configuration:

  1. Select Start > Search, and enter ODBC Data Sources in the Search box.
  2. Choose the version of the ODBC Administrator that corresponds to the bitness of your Power BI Desktop installation (32-bit or 64-bit).
  3. Select the system data source and click Configure.
  4. Edit the information on the Connection tab and click OK.

System DSN

Configure the system DSN the same way as the user DSN, except you will need to switch to the System DSN tab before performing Step 3.

If you're using Power BI's On-Premises Data Gateway with Standard mode, you must use the system DSN.

You must also specify a valid location for OAuthSettingsLocation (a path where OAuth credentials are locally stored to avoid repeated OAuth prompts).

This is because the Standard mode runs on service mode and can only access permitted locations, such as C:\Windows\ServiceProfiles\PBIEgwService\AppData\Local\Microsoft\On-premises data gateway.

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

Copyright (c) 2024 CData Software, Inc. - All rights reserved.
Build 24.0.9060