IBM Cloud Data Engine

Version 24.3.9120


IBM Cloud Data Engine


You can use the IBM Cloud Data Engine connector from the CData Sync application to capture data from IBM Cloud Data Engine 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 IBM Cloud Data Engine Connector

To enable Sync to use data from IBM Cloud Data Engine, 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 IBM Cloud Data Engine 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 IBM Cloud Data Engine connector. For more information about installing new connectors, see Connections.

Authenticate to IBM Cloud Data Engine

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

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

  • Api Key - Enter the API key that you use to authenticate to IBM Cloud. Follow these steps to locate your API key:

    1. Log in to your Cloud account.

    2. Navigate to the Platform API Keys page.

    3. Click Create an IBM Cloud API Key to create a new API key.

    4. In the pop-up window that appears, specify the API key name and click Create. Copy and save the API key because you can never access that key again from the dashboard.

Complete Your Connection

To complete your connection:

  1. Specify the following properties:

    • Cloud Object Storage CRN (optional) - Enter your Cloud Object Storage cloud-resource name (CRN). You can obtain this value in one of the following ways:

      1. Query the Services view. This action lists your IBM Cloud Object Storage instances along with the CRN for each one.

      2. Locate the CRN directly in IBM Cloud:

        1. Open your IBM Cloud Dashboard and navigate to Resource List.

        2. In the Storage section, select your Cloud Object Storage resource to obtain its CRN.

      3. Navigate to SQL Query page, choose a name for your instance, and click Create. You will be redirected to the instance of SQL Query that you created.

    • Sql Query CRN (optional) - Enter the CRN that uniquely identifies your SQL query in IBM Cloud. You can obtain this value as follows:

      1. Query the Services view. This action lists your Cloud Object Storage instances along with the CRN for each one.

      2. Locate the CRN directly in IBM Cloud:

        1. Open your IBM Cloud Dashboard and navigate to Resource List.

        2. In the Services section, select the SQL Query service to obtain its CRN.

      3. Navigate to SQL Query page, choose a name for your instance, and click Create. You will be redirected to the instance of SQL Query that you created.

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

  3. Click Create & Test to create your connection.