Skip to Content

IBM Cloudant Connector


The Jitterbit Harmony IBM Cloudant Connector establishes access to IBM Cloudant.

The IBM Cloudant connector provides an interface for creating an IBM Cloudant connection, the foundation used for generating instances of IBM Cloudant activities. Activities interact with IBM Cloudant through the connection and are intended to be used as sources (to provide data in an operation) or targets (to consume data in an operation).

The IBM Cloudant connector is accessed from the design component palette's Connections tab (see Design Component Palette).


This connector can be used only with Private Agents. In addition, it is a Connector SDK-based connector, which may be referred to by Jitterbit when communicating changes made to connectors built with the Connector SDK.

Connection Documentation

In addition to the IBM Cloudant connection, see Jitterbit's comprehensive IBM Cloudant connection details page. Configuration details such as these are included on that page:

  • Getting Started: Initial steps for establishing a connection.
  • Advanced Features: User-defined views and SSL configuration.
  • Data Model: The data model that the connector uses to represent the endpoint.
  • Advanced Configurations Properties: Properties that can be defined to configure a connection for both basic and advanced configurations.

Activity Documentation

Together, a specific IBM Cloudant connection and its activities are referred to as an IBM Cloudant endpoint:

IBM Cloudant activity types

  • Query: Retrieves records from a table at IBM Cloudant and is intended to be used as a source in an operation.

  • Create: Inserts a record into a table at IBM Cloudant and is intended to be used as a target in an operation.

  • Update: Updates a record in a table at IBM Cloudant and is intended to be used as a target in an operation.

  • Delete: Deletes a record from a table at IBM Cloudant and is intended to be used as a target in an operation.

Prerequisites and Supported API Versions

The IBM Cloudant connector requires the use of an agent version 10.1 or later. These agent versions automatically download the latest version of the connector when required.

This connector requires the use of a Private Agent.

Refer to the documentation for information on the schema nodes and fields.

OAuth Authentication

OAuth authentication is supported as described in Configure OAuth Connections.


If you experience issues with the IBM Cloudant connector, these troubleshooting steps are recommended:

  1. Ensure the IBM Cloudant connection is successful by using the Test button in the configuration screen. If the connection is not successful, the error returned may provide an indication as to the problem.

  2. Check the operation logs for any information written during execution of the operation.

  3. Enable operation debug logging for Private Agents to generate additional log files and data.

  4. Enable connector verbose logging for this connector using this specific configuration entry of logger name and level:

    <logger name="org.jitterbit.connector.verbose.logging.Cloudant" level="TRACE"/>
  5. Check the agent logs for more information.