VOOZH about

URL: https://www.cdata.com/kb/tech/cosmosdb-cloud-jitterbit.rst

⇱ Integrate with live Cosmos DB Data in Jitterbit

Integrate with live Cosmos DB Data in Jitterbit

👁 Mohsin Turki
Mohsin Turki
Technical Marketing Engineer
Use CData Connect AI to connect to and integrate live Cosmos DB data in Jitterbit.

Jitterbit is an enterprise iPaaS (integration platform as a service) that lets you streamline your data workflows. When paired with CData Connect AI, Jitterbit gets access to live Cosmos DB data. This article demonstrates how to connect to Cosmos DB using Connect AI and integrate with live Cosmos DB data in Jitterbit.

CData Connect AI provides a pure OData interface for Cosmos DB, allowing you to query data from Cosmos DB without replicating the data to a natively supported database. Using optimized data processing out of the box, CData Connect AI pushes all supported SQL operations (filters, JOINs, etc.) directly to Cosmos DB, leveraging server-side processing to return the requested Cosmos DB data quickly.

Configure Cosmos DB Connectivity for Jitterbit

To work with Cosmos DB data from Jitterbit, we need to connect to Cosmos DB from Connect AI, provide user access to the connection, and create a Workspace for the Cosmos DB data.

Connect to Cosmos DB from Connect AI

CData Connect AI uses a straightforward, point-and-click interface to connect to data sources.

  1. Log into Connect AI, click Sources, and then click Add Connection
    2. 👁 Adding a Connection
  2. Select "Cosmos DB" from the Add Connection panel
    3. 👁 Selecting a data source
  3. Enter the necessary authentication properties to connect to Cosmos DB.

    To obtain the connection string needed to connect to a Cosmos DB account using the SQL API, log in to the Azure Portal, select Azure Cosmos DB, and select your account. In the Settings section, click Connection String and set the following values:

    • AccountEndpoint: The Cosmos DB account URL from the Keys blade of the Cosmos DB account
    • AccountKey: In the Azure portal, navigate to the Cosmos DB service and select your Azure Cosmos DB account. From the resource menu, go to the Keys page. Find the PRIMARY KEY value and set AccountKey to this value.
    👁 Configuring a connection (Salesforce is shown)
  4. Click Save & Test
  5. Navigate to the Permissions tab in the Add Cosmos DB Connection page and update the User-based permissions. 👁 Updating permissions

Add a Personal Access Token

When connecting to Connect AI through the REST API, the OData API, or the Virtual SQL Server, a Personal Access Token (PAT) is used to authenticate the connection to Connect AI. It is best practice to create a separate PAT for each service to maintain granularity of access.

  1. Click on the Gear icon () at the top right of the Connect AI app to open the settings page.
  2. On the Settings page, go to the Access Tokens section and click Create PAT.
  3. Give the PAT a name and click Create. 👁 Creating a new PAT
  4. The personal access token is only visible at creation, so be sure to copy it and store it securely for future use.

Configure Cosmos DB Endpoints for Jitterbit

After connecting to Cosmos DB, create a workspace for your desired table(s).

  1. Navigate to the Workspaces page and click Add to create a new Workspace (or select an existing workspace). 👁 The Workspaces page.
    👁 Adding a new Workspace.
  2. Click Add to add new assets to the Workspace.
  3. Select the Cosmos DB connection (e.g. CosmosDB1) and click Next. 👁 Selecting an Asset (Salesforce is shown).
  4. Select the table(s) you wish to work with and click Confirm. 👁 Selecting Tables (Salesforce is shown).
  5. Make note of the OData Service URL for your workspace, e.g. https://cloud.cdata.com/api/odata/{workspace_name}

With the connection, PAT, and Workspace configured, you are ready to connect to Cosmos DB data from Jitterbit.

Connect to Cosmos DB from Jitterbit using Connect AI

To establish a connection from Jitterbit to CData Connect AI using the OData protocol, follow these steps.

  1. Log into Jitterbit.
  2. Create a project in Cloud Studio and provide a workspace environment for it. 👁 Creating a new project in Jitterbit.
  3. click Sources and enter OData in the search bar.
  4. Select the OData connector.
  5. Enter the OData connection properties.
    • Connection Name: enter a connection name.
    • OData Metadata URL: enter https://cloud.cdata.com/api/odata/{workspace_name}.
    • Authentication: select Basic Auth.
    • User Name: enter your CData Connect AI username. This is displayed in the top-right corner of the CData Connect AI interface. For example, [email protected].
    • Password: enter the PAT you generated on the Settings page.
    👁 Configuring connectivity to the Connect AI OData endpoint.
  6. Click Test to test the connection, and then click Save Changes.
  7. Choose the operation you want to perform and drag it to the workflow in your project. 👁 Selecting the operation for the workflow.
  8. Double-click the query operation to see all the tables and derived views available in your OData endpoint. 👁 Viewing the available endpoints.
  9. Select a table and configure the query.

You can now transform and integrate live Cosmos DB data in Jitterbit.

Get CData Connect AI

To get live data access to hundreds of SaaS, Big Data, and NoSQL sources directly from Jitterbit, try CData Connect AI today!