Skip to Content

IBM Cloudant Connector

Summary

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 Connectivity tab (see Connectors in Design Component Palette).

Note

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

See Jitterbit's comprehensive IBM Cloudant connection documentation, which is provided at a dedicated website. Configuration details such as these are included:

  • 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.
  • Connection String Options: Properties that can be defined to configure the 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. (Generically documented in Query Activities.)

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

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

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

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.

Verbose Logging

Verbose logging can be enabled for this connector. See Verbose Logging for Connectors for details.

Invoke verbose logging for this connector using this configuration entry:

<logger name="org.jitterbit.connector.verbose.logging.Cloudant" level="TRACE"/>