Version 24.2.8980

• Add the Cloudant Connector
• Authenticate to Cloudant
  • Basic
  • OAuth
• Complete Your Connection
• More Information

You can use the Cloudant connector from the CData Sync application to capture data from Cloudant and move it to any supported destination. To do so, you need to add the connector, authenticate to the connector, and complete your connection.

Add the Cloudant Connector

To enable Sync to use data from Cloudant, you first must add the connector, as follows:

1. Open the Connections page of the Sync dashboard.

2. Click Add Connection to open the Select Connectors page.

3. Click the Sources tab and locate the Cloudant row.

4. Click the Configure Connection icon at the end of that row to open the New Connection page. If the Configure Connection icon is not available, click the Download Connector icon to install the Cloudant connector. For more information about installing new connectors, see Connections.

Authenticate to Cloudant

After you add the connector, you need to set the required properties.

• Connection Name - Enter a connection name of your choice.

• URL - Enter the URL for your Cloudant server instance (for example, http://localhost:8006).

CData Sync supports authenticating to Cloudant in several ways. Select your authentication method below to proceed to the relevant section that contains the authentication details.

• Basic (default)
• OAuth

Basic

To connect with your user credentials, set the following properties:

• Auth Scheme: Select Basic.

• User - Enter the username that you use to authenticate to your Cloudant account.

• Password - Enter the password that you use to authenticate to your Cloudant account.

OAuth

To connect with OAuth custom credentials, specify the following properties:

• Auth Scheme – Select OAuth.

• Api Key - Enter the API key that identifies you to IBM Cloud. For security reasons, the API key is available only at the time of creation. If you did not save your key or cannot find it, you need to create a new key, as follows:

  1. In the IBM Cloud console, navigate to Manage > Access (IAM) > API keys.

  2. Click Create an IBM Cloud API key.

  3. Enter a name and description for your API key.

  4. Click Create.

  5. Click Show to display the new API key. Then, click Copy or Download to save it for later use.

Complete Your Connection

To complete your connection:

1. Define advanced connection settings on the Advanced tab. (In most cases, though, you should not need these settings.)

2. If you authenticate with OAuth, click Connect to Cloudant to connect to your Cloudant account.

3. Click Create & Test to create your connection.

More Information

For more information about interactions between CData Sync and Cloudant, see Cloudant Connector for CData Sync.