IBM App Connect passes key data between IBM Cloudant databases and other apps – automatically, in real time.

You can use App Connect to connect IBM Cloudant databases to your apps by mapping data graphically – without the need for coding – meaning that you can achieve a return on your investment in minutes or hours, not days or months.

If you can’t find what you want, or have comments about the “how to” information, please either add comments to the bottom of this page or .

IBM Cloudant, a highly scalable and performant JSON (JavaScript Object Notation) database service, stores JSON formatted documents. Thanks to functionality offered in App Connect, you do not have to write this JSON by hand, but you are able to define the document properties (names and data types) and then map to those properties as you would any other properties in App Connect.

What should I consider first?

  • To use Cloudant with App Connect, you must have provisioned a Cloudant NoSQL DB service on IBM Cloud.

    You can connect App Connect to the Cloudant application either from the Applications tab on the App Connect Catalog page, or when you add the application to a flow.

    • If your service instance uses IBM Cloud Identity and Access Management (IAM) authentication only, or both legacy credentials and IAM, provide the following connection details:
      • Cloudant host: The host name of the instance
      • Cloudant API key: The API key for the instance
    • If your service instance uses legacy credentials for authentication, provide the following connection details:
      • Cloudant user name: The name of the service instance user
      • Cloudant password: The password for the specified user name
      • Example of completed fields for connecting from App Connect using IAM authentication only, or both legacy credentials and IAM

        Example of Cloudant connection details

    You can find the connection values on the “Service credentials” page for the service instance in IBM Cloud:

    1. Log in to IBM Cloud.
    2. From the IBM Cloud Dashboard, click the Cloudant service instance that you want to work with.
    3. To view the service credentials, click Service credentials in the left pane, and then click View credentials. (If you want to define new credentials to use, click New credential.)
      • If your service instance supports IAM authentication only, or both legacy credentials and IAM, copy the host and API key values, and paste them into the App Connect fields.

        Viewing the IAM authentication credentials for Cloudant

      • If your service instance uses legacy (Cloud Foundry) authentication, copy the user name and password, and paste them into the App Connect fields.

  • You can specify your Cloudant document data structure as data properties (with name and data type) or as a JSON object that consists of comma-separated name/value pairs. For example:
    • Cloudant document data structure specified as data properties:

      (Click the image to view full size.)

      To specify your Cloudant document data structure as data properties, click Add property under the “Document data” heading. (If you have been specifying document data as JSON, ensure that the “Document data” field is empty and then click Add property.) For more information about specifying data properties, see Defining your own data properties.

    • Cloudant document data structure specified as JSON:

      (Click the image to view full size.)

      To specify your Cloudant document data structure as JSON, ensure that there are no properties under the “Document data” heading and then click “Edit mappings”.

    Example

    Creating an event-driven flow that syncs updates to Salesforce data with IBM Cloudant documents

    Learn how to use App Connect Designer to create an event-driven flow that when a new Salesforce contact is created, creates a document in IBM Cloudant with data from Salesforce. This tutorial demonstrates how to easily specify your own data properties for an IBM Cloudant document, without needing to write JSON.

    Join The Discussion

    Your email address will not be published. Required fields are marked *