Power BI Connector for Cloudant

Build 24.0.8963

Creating the Data Source Name

This section describes how to edit the DSN configuration and then authenticate and connect to Cloudant 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.

Authenticating to Cloudant

Cloudant supports two types of authentication:

  • OAuth: Performs authentication based on the OAuth standard. Set AuthScheme to OAuth and supply the values for the Cloudant instance APIKey and URL.
  • Basic: Basic username/password authentication. Set AuthScheme to Basic.

IBM Cloudant Legacy

To connect via IBM Cloudant Legacy, ensure that you have a valid IBM Cloudant service credential.

To create an IBM Cloudant service credential:

  1. Log in to the IBM Cloud dashboard.
  2. Navigate to the Menu icon > Resource List, and open your IBM Cloudant service instance.
  3. In the menu, click Service credentials.
  4. Click New credential. Cloudant displays a Add new credential window.
  5. Enter a name for the new credential.
  6. Click Add. Your credentials are added to the Service credentials table.
  7. Click Actions > View credentials.
  8. Extract the values for User and Password from the JSON file.

Use the values you just obtained to set the User and Password.

Authenticating to a Local Instance

Cloudant supports authenticating to data in local instances from version 1.1.0 and above.

To authenticate to your local instance, set these parameters:

  1. Url: The Url of your local instance. For example: http://localhost:8006
  2. User: Your username.
  3. Password: Your password.

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