> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sync.cdata.com/llms.txt
> Use this file to discover all available pages before exploring further.

# IBM Cloud Data Engine

export const CommonDatasourceAddConnector = ({datasource = "the data source", title = "the connector", destination = false, siteNameShort = "Sync"}) => {
  return <>
      <p>
        To enable {siteNameShort} to use data from {datasource}, you first must add the
        connector, as follows:
      </p>
      <ol>
        <li>Open the <strong>Connections</strong> page of the {siteNameShort} dashboard.</li>
        <li>Click <strong>Add Connection</strong> to open the <strong>Select Connectors</strong> page.</li>
        <li>
          Click the <strong>{destination ? "Destinations" : "Sources"}</strong> tab and locate
          the <strong>{title}</strong> row.
        </li>
        <li>
          Click the <strong>Configure Connection</strong> icon at the end of that row to open
          the <strong>New Connection</strong> page. This action opens the{' '}
          <strong>Add Connection</strong> dialog box.
          <br />
          <strong>Note:</strong> If the <strong>Configure Connection</strong> icon is not
          available, click the <strong>Download Connector</strong> icon to install
          the {title} connector.
        </li>
        <li>Enter a name for your connection in the <strong>Add Connection</strong> dialog box.</li>
        <li>Click <strong>Add</strong> to open the <strong>Settings</strong> tab for your connector.</li>
      </ol>
      <p>
        For more information about installing new connectors, see{' '}
        <a href="../connections">Connections</a>.
      </p>
    </>;
};

export const CommonDatasourceIntroSource = ({datasource = "the data source", siteName = "CData Sync"}) => {
  return <p>
      You can use the {datasource} connector from the {siteName} application to capture data
      from {datasource} and move it to any supported destination. To do so, you need to add
      the connector, authenticate to the connector, and complete your connection.
    </p>;
};

export const driverVersion = "M";

export const siteNameShort = "Sync";

export const siteName = "CData Sync";

export const datasource = "IBM Cloud Data Engine";
export const pageTitle = "IBM Cloud Data Engine";
export const advancedurl = "SI";

<CommonDatasourceIntroSource datasource={datasource} siteName={siteName} />

## Add the IBM Cloud Data Engine Connector

<CommonDatasourceAddConnector datasource={datasource} title={pageTitle} destination={false} siteNameShort={siteNameShort} />

## Authenticate to IBM Cloud Data Engine

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

**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:
   * (Optional) **Cloud Object Storage CRN:** 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.
   * (Optional) **Sql Query CRN:** 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.